Selasa, 09 Desember 2008

Menulis Script Php yang baik

Sebagian orang mungkin menganggap hal yang akan dibahas dalam tulisan ini adalah hal sepele. Tetapi sebenarnya tidak. Penulisan yang baik meliputi format, penamaan variable, fungsi dan sebagainya adalah hal yang penting, baik bagi orang lain maupun bagi si pembuat script.

Indikator paling mudah untuk menyatakan bahwa gaya penulisan script Anda telah baik dan benar adalah jika orang lain mampu dengan mudah membaca dan mengerti tujuan dari script yang Anda buat. Atau, Anda juga bisa melakukan penilaian sendiri dengan cara membuka script-script buatan Anda yang sudah lama tidak dibuka. Jika Anda bisa mengerti dengan mudah atas script-script yang Anda buat tersebut, mungkin Anda sudah melakukan penulisan script PHP yang baik –minimal untuk diri sendiri :)

Sebenarnya tidak ada aturan baku dalam dunia pemrograman tentang bagaimana menulis program atau script yang baik. Artinya, siapa pun bebas untuk membuat aturan main sendiri selama aturan tersebut konsisten dan mudah dibaca/dimengerti minimal untuk diri sendiri atau kelompok kerja.

Berikut beberapa hal yang umum dan sering dipakai sebagai standar penulisan script.

1. Pergunakan identasi

[php]
for($i=0;$i<30;$i++) {
$ax[$i]=$mx*sqrt($ns_circle);
$ay[$i+1]=$ax[$i]*$next_operand;
for($i=0;$i<30;$i++) {
$am[$i]=$mx*sqrt($ns_circle);
$an[$i+1]=$ax[$i]*$next_operand;
}
}
[/php]

Akan lebih mudah dibaca jika ditulis menggunakan identasi seperti dibawah

[php]
for($i=0;$i<30;$i++) {
$ax[$i]=$mx*sqrt($ns_circle);
$ay[$i+1]=$ax[$i]*$next_operand;
for($i=0;$i<30;$i++) {
$am[$i]=$mx*sqrt($ns_circle);
$an[$i+1]=$ax[$i]*$next_operand;
}
}
[/php]

2. Berilah nama variable yang jelas

[php]
if($tlhr>$thi) {
// proses X
}
[/php]

Bandingkan dengan scrip dibawah ini

[php]
if($tgl_lahir > $tgl_hari_ini) {
// proses X
}
[/php]

Tanpa harus membaca isi script secara keseluruhan dengan meneliti variable yang dijadikan kondisi, pembaca script kurang lebih sudah mengerti apa isi variable-varible tersebut dan kapan proses X akan dieksekusi.

Cara lain yang sering digunakan adalah dengan menambahkan prefix tipe variable pada nama variable. Cara ini sangat membantu untuk memperjelas tujuan dari sebuah variable dibuat.

[php]
$anama; // ini adalah variable bertipe array
$onama; // ini adalah variable bertipe object
$hnama; // ini adalah varible bertipe handle, misalnya untuk fileopen
$bpass; // ini adalah variable boolean
$dlahir; // ini adalah variable bertipe tanggal
// dsb
[/php]

Khusus untuk konstanta, tulislah namanya dengan menggunakan huruf besar semua.

Tidak ada komentar:

Posting Komentar