belakangan, kl gw coding, kadang suka bikin gw kebingungan sendiri. coding yang berantakan, dan sulit untuk menelusuri kalo lagi error.
dan kadang rada ribet juga kalau harus bekerja sama orang dengan gaya coding yang berbeda. dan ini membuat gw terinspirasi untuk mempelajari hal yang tabu dan simple tp kadang di abaikan yaitu ‘clean code’
1. Indentasi
indentasi memudahkan kita untuk menelusuri function atau looping di codingan. ada beberapa gaya indentasi silahkan merujuk kesini : http://en.wikipedia.org/wiki/Indent_style, dan apapun gaya indentasi anda itu tidak begitu penting, gaya indentasi yang tidak boleh dipakai adalah tidak memakai indentasi.
2. Kurung
Biasakan menggunakan kurung. PHP memberikan kemudahan dengan menggunakan satu baris statement IF atau FOR tanpa menggunakan kurung. kalau bisa jangan menggunakan hal itu. itu membuat coding agak sedikit sulit dibaca dan membuka celah untuk bugs.
3. berikan komentar pada coding
meskipun coding yg baik bisa rumit. tapi biasakan berikan komentar di codingan. tapi gk musti setiap baris diberikan komentar, tapi di setiap fungsi-fungsi dasar. jika Anda memiliki proses yg rumit(atau sulit di baca) berikan komentar di setiap tahap. agar programmer berikutnya paham apa yg anda kerjakan di codingan tersebut. dan ingat pula Eagleson’s law “Any code of your own that you haven’t looked at for six or more months might as well have been written by someone else.”
4. Make everything as simple as possible, but not simpler.
buat codingan Anda sesederhana mungkin seperti Kutipan Albert Einstein. sesusatu yang sederhana kadang membuat rumit, dan sulit di baca. jangan takut untuk menggunakan codingan rumit jika diperlukan, berikan saja komentar. tapi jika memungkinkan, buatlah sesederhana mungkin Brian W. Kernighan said “Debugging is twice as hard as writing the code in the first place. Therefore, if you write the code as cleverly as possible, you are, by definition, not smart enough to debug it.“
alasan lain karena menambahkan hal ini ke aplikasi akan membuat rumit. tapi kenapa tidak memulai dari yang mudah dan perlahan menanjak dibanding memulai dari atas sampai tidak ada ruang untuk bergerak.
5. Gunakan Nama variable yang deskriptif
dengan indentasi yg baik, komentar dan codingan yg sederhana, nama variable yg buruk tetap akan membuat aplikasi sulit di modifikasi. jangan pernah memberikan variable dengan lebih dari 3 angka (itu alasan nya kenapa codingan tidak disebut novel :p), jelaskan maksud dan tujuan dari variable tersebut. misalkan kita mempunyai mysql query yg mengambil post dari semua forum, nama yang baik harus nya menjadi $posts_query. nama variabel $query kurang baik untuk codingan, bisa universal dan bisa jadi itu menceritakan segala query. sama halnya dengan nama function.
6. variable yang enak dipandang
penamaan variable yg deskriptif itu penting. tapi akan sia-sia jika penamaan variable nya ditulis dengan $postsquery. hal itu membuat sulit untuk di baca karena programmer berikutnya harus memisahkan kata-kata tersebut. ada baiknya dengan mengguankan huruf awal di setiap awal kata($PostsQuery) atau dengan menggunakan underscore ($posts_query).
7. Jika Anda tidak menggunakan template, sisipkan PHP di HTML, bukan HTML di PHP
akan lebih mudah membaca HTML dengan disisipkan PHP daripada menampilkan HTML di dalam PHP dengan segala Qoute escape yg dituliskan, misalnya :
if($condition == "value")
{
?>
<input type="text" name="<?php echo $name; ?>" />
<?php
}
dengan
If($condition == "value")
{
echo "<input type=\"text\" name=\"$name\" />";
}
sebenarnya tidak membuat pengaruh besar. tapi ketika melakukan output dengan HTML yg banyak. akan lebih mudah dibaca jika Anda meletakan PHP di dalam HTML.
