Dec
17
2007
Tutorial

Menulis Script PHP Yang Baik

Author An article by Riyogarta    Comments 12 Comments

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 

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;
}
}

Akan lebih mudah dibaca jika ditulis menggunakan identasi seperti dibawah

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;
   }
}

2. Berilah nama variable yang jelas

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

Bandingkan dengan scrip dibawah ini

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

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.

$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

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

About the Author: Riyogarta Pratikto

12 Comments + Add Comment

  • roy 17 December 2007 at 10:08 pm

    Saya mau mendaftar sebagai Komunitas Pengguna PHP Indonesia
    gimana sich caranya?

  • akhid rosyidi 17 December 2007 at 10:11 pm

    yup, sepakat bung!

    jika banyak variable yang udah dibuat kadang kita lupa tuh typenya apa dan untuk apa.

    denan sepeti itu bisa terstruktur, lebih mudah menelusuri kesalahan.

    trims dech

  • Gin Vortex 24 December 2007 at 10:19 am

    penulisan skrip program tuh sebenarnya menurut gaya masing – masing orang. gak semua orang tuh mempunyai ciri – ciri penulisan yang sama.
    tapi artikel lo boleh juga buat masukan.ni gw juga mo tambahin

    biasanya programmer suka menggunakan tanda underscore ( _ ) sebagai pemisah kata pada penamaan fungsinya ex.

    function hitung_pendapatan()
    function cetak_struk()

    memang php tidak “mengharamkan” penggunaan underscore pada skripnya tetapi hal ini dapat menyulitkan orang lain yang membacanya dalam membedakan fungsi dalam php dengan fungsi yang telah kita buat, karena sebagian besar fungsi yang berada dalam php menggunakan underscore sebagai pemisah kata.
    sebagai solusinya kita bisa menggabungkan nama fungsinya dan selain pada kata pertama menggunakan huruf kapital ex.

    function hitungPendapatan()
    function cetakStruk()
    function listDataEmployee()

    semoga berguna untuk kita semua

  • nirwansyah 12 January 2008 at 6:27 pm

    Pada awal pembelajaran php saya sering menggunakan suatu variable/function/class tanpa menggunakan “_” (underscore) tapi setelah beberapa cycle pengembangan ternyata untuk membaca hal tsb menjadi semakin sulit karena selalu ada yang baru. kalo berdasarkan pengalaman saya lebih mudah dengan “-” yang dimulai dengan kelompok tertentu dan diikui dengan detil kelompoknya contohnya:
    untuk fungsi tanggal
    &tanggal_get
    $tanggal_list
    $tanggal_convert
    dll

    juga untuk fungsi koneksi database
    $db_user
    $db_host
    $db_password
    dll

    juga untuk membuat suatu list table yang diambil dari database
    $employee_name
    $employee_salary
    $employee_address
    dll

    juga untuk membuat fungsi
    function employee_list(…)
    function employee_new(…)
    function employee_del(…)
    function employee_upd(…)

    dan itu semua tidak terlepas dari kebiasaan kita membaca suatu script coding. semoga bermanfaat.

  • wira 30 January 2008 at 9:46 pm

    salam kenal,
    saya setuju semuanya :-)

    btw, apa sih bedanya penulisan “echo” dibawah ini :
    echo(“tes”);
    vs
    echo ‘tes’;

  • studiowebsite.net 31 January 2008 at 3:20 pm

    Ya, stile menulis kode memang suka-suka kita, tapi harus konsisten. Banyak sih buku yang merekomendasikan cara penulisan yang baik,tapi semua itu tergantung orangnya.

  • sugenk 3 February 2008 at 10:18 pm

    yups, bener. antar CMS aja kadang standart penulisannya berbeda2…
    kalo saya sih semuanya ok, seribet apapun gak apa2 asal nggak di enkripsi pake ion_cube, zend_encoder, dsb. wkkakakakakaa…

  • aab32 13 February 2008 at 10:17 pm

    Pemula Nih Tempatnya Dimana Ya?Mau Tau Dong Tips meminimalisir file.php(maksudnya dalam satu index saja bisa ada beberapa menu Contoh:www.aab32.com dengan menu: profil, Kontak, dll lah pokoknya saya tidak harus tulis banyak2 file.php)mohon maklum:)

  • imamiscool (again) 28 February 2008 at 5:13 pm

    biasa juga disebut (ama orang2 bule) ‘coding convention’ atau aturan penulisan kode,
    kalo mau belajar googling ajah, ada banyak aturan yang udah terkenal.

  • Mr_e 3 July 2008 at 8:17 am

    aab32…biasanya saya pake 1 file index.php tapi di dalamnya saya kasih kondisi Action,
    Misalnya untuk
    if($Action==’Input’){
    // Jalankan blok perintah input data
    }
    dll

    sekalian nanya karena newbie juga..cara kyk gitu efektif ga ya..thx

  • indah 19 October 2008 at 3:38 pm

    saya masih bgg dgn function PHP.. ad yg bs bntu g’??

  • Bike Bali 13 December 2008 at 5:46 pm

    sukses, jadi ikut nambah pengetahuan baca sini…
    makasih mas

Leave a comment