Penting nggak sih standar penulisan dalam sebuah program?

Setelah sekian lama berkecimpung di dunia “coding”, ternyata masih banyak aku temuin kode yang nggak konsisten dalam hal model penulisan. Padahal semakin hari semakin menumpuk kode-kode tersebut, yang pada akhirnya bisa menyebabkan menjadi hutan rimba yang susah banget untuk merawatnya (lebih tepatnya kayak rambut kribo kali yee).

Nah, pada kesempatan kali ini aku mencoba untuk menyadur tulisan yang ada di internet tentang bagaimana caranya untuk membuat sebuah coding yang konsisten dalam hal penulisannya sehingga memudahkan bagi orang lain untuk merawat kode tersebut karena bersih dan mudah dibaca struktur dan alur programnya.

Beberapa tips dalam coding yang disadur dari Pear Standards dengan sedikit modifikasi adalah sebagai berikut:

Penggunaan tanda petik tunggal atau ganda
Jika memungkinkan, tanda petik tunggal dan ganda bisa digunakan menurut kebutuhan. Jika kamu tidak membutuhkan evaluasi sesuatu di dalam string, gunakan petik tunggal. Kamu tidak harus melakukan Escape HTML Quotes di dalam string, karena kamu bisa mengganti penulisan tanda petik tersebut, seperti contoh berikut:

echo "$linkname“;
echo ‘Link name‘;


Perkecualian untuk hal ini adalah JavaScript, yang kadang-kadang memerlukan petik tunggal atau ganda. Teks yang akan dimasukkan ke dalam atribut harus di Texturize sehingga penggunaan petik tunggal atau ganda tersebut bisa menyebabkan tidak tertutupnya isi atribut dan menyebabkan tidak validnya XHTML.

Indentation
Indentation atau penulisan menjorok ke dalam, bisa merefleksikan struktur logis dalam sebuah kode, Gunakan TAB bukan SPASI, untuk fleksibilitas terhadap semua editor.

Model kurung kurawal (Brace Style)
Penggunaan model kurung kurawal yang benar akan memudahkan pembacaan. Berikut contoh dari situs Pear:

if ( (condition1) || (condition2) ) {
action1;
} elseif ( (condition3) && (condition4) ) {
action2;
} else {
defaultaction;
} // end blah


Jika kamu memiliki sebuah blok logika yang panjang tambahkan sedikit komentar setelah kurung kurawal penutup, sehingga orang yang membacanya mudah mengenali kurawal penutup tersebut. Gunakan komentar ini hanya jika panjangnya blok logika lebih dari 35 baris.

include_once vs. require_once
Pelajari dulu bedanya antara include_once() dengan require_once(), dan gunakan sesuai dengan kebutuhan. Di Manual PHP disebutkan bahwa

“The two constructs are identical in every way except how they handle failure. include() produces a Warning while require() results in a Fatal Error. Fatal errors stop script execution.”

Jangan gunakan model penulisan pendek dari PHP
Biarpun PHP bisa menggunakan tag model pendek (< ? ... ?>), disarankan selalu menggunakan model panjangnya (< ?php ... ?>). Tujuannya adalah untuk memudahkan pembacaan.

Gunakan spasi
Selalu gunakan spasi setelah koma dan di antara logical dan assignment operators seperti:
x == 23
foo && bar
array(1, 2, 3)

Gunakan juga pada tanda kurung buka dan tutup pada sintaks if, elseif, foreach, for dan switch blocks
foreach ( $foo as $bar ) { ...

Format SQL statements
Ketika menuliskan SQL statements, bagilah menjadi beberapa baris dan pakailah indent jika sintaksnya cukup kompleks. Akan tetapi hati-hati, ada beberapa statement yang tidak bisa dibagi menjadi beberapa baris, cukup satu baris saja. Selalu gunakan model huruf kapital untuk sintaks SQL seperti UPDATE atau WHERE untuk memudahkan pembacaan.

Query Database
Usahakan tidak menyentuh database secara langsung. Jika ada sebuah defined function yang dapat membantumu mendapatkan data, gunakanlah. Dengan menggunakan sebuah fungsi (daripada query langsung) akan membantu membuat kode lebih bersih, forward-compatible (lebih mudah diupgrade) dan jika dalam kasus tertentu hasil query dimasukkan ke dalam cached memory akan mempercepat performa sistem.

Jika dalam kasus tertentu harus menyentuh database secara langsung, usahakan membuat fungsinya sehingga di lain waktu bisa dipakai kembali fungsi tersebut.

Variables, functions, and operators
Jika kamu tidak menggunakan variabel lebih dari satu kali, jangan buat.

Ternary operators diperbolehkan, tetapi akan membuat sistem selalu melakukan evaluasi terhadap sebuah nilai TRUE atau FALSE, dan yang paling sreing adalah membuat bingung di kemudian hari.

// GOOD example:
// (if statement is true) ? (do this) : (if false, do this);
$alert = ('1.5.1' == $version) ? 'This version is 1.5.1' : 'This version is NOT 1.5.1';
// BAD example:
// (if statement is false) ? (do this) : (if true, do this);
$alert = ('1.5.2' != $version) ? 'This version is NOT 1.5.2' : 'This version is 1.5.2';


Poin penting selain yang disebutkan di atas, jika melakukan perbandingan logis, taruh variabel di sisi kanan seperti contoh di atas. Jika kamu lupa tanda sama dengan (==) akan menimbulkan error, padahal tujuannya hanya mengevaluasi sebuah nilai dan melakukan sebuah eksekusi. Ini akan menyita waktu untuk melakukannya.

Setelah kamu membaca poin-poin di atas, masihkah menganggap bahwa standar penulisan itu tidak penting ? Semoga tulisan ini bermanfaat bagi yang membaca.