Tutorial Pedoman Menulis Kode Program PHP yang Baik

Oleh Unknown

Saturday, March 14, 2015

Bagikan :

Tweet

Program yang kita buat suatu saat mungkin akan di kembangkan oleh banyak orang. Apalagi jika lama-kelamaan program Anda berkembang dan cukup kompleks, tentu kita membutuhkan bantuan tim kerja untuk membantu. Agar anggota tim kerja Anda dapat membantu mengembangkan program kelak, sebaiknya dalam menulis program Anda mengikuti beberapa kaidah dasar agar anggota tim kita dapat dengan mudah pula mengerti alur program kita.

Ada beberapa kaidah pemograman web yang sebenarnya cukup terlupakan bahkan bagi kita yang sering menulis kode-kode program. Dalam hal ini saya akan memaparkan beberapa aturan-aturan dalam pemograman PHP.

• Penutup tag PHP ?>

Sebenarnya penutup tag php itu bersifat opsional. Justru lebih buruk lagi, dapat menyebabkan eror menjadi tak terdeteksi. Karena bila tag ?> digunakan dan terdapat baris kosong setelahnya, kita tidak akan mengetahui adanya eror pada baris program alias blank page. 

• Penamaan Class dan Method

Ini untuk Anda yang sudah berkecimpung di metode objek oriented program. Ketika Anda menamakan Class hendaknya menggunakan huruf capital di awal. Bila nama class terdapat dari 2 kata, pisahkan dengan underscore ( _ ). Berikut contohnya penulisan

Penulisan yang kurang baik

class superclass

class SuperClass

Penulisan yang baik

class Super_class

               

Untuk penulisan method pada class sebaiknya menggunakan huruf kecil semua. Bila ada 2 kata pisahkan juga dengan underscore. Usahakan membuat nama yang singkat namun deskriptif dan menggunakan huruf kecil semua. Berikut contoh perbandingannya.

Penulisan yang kurang baik:

function fileproperties() // tidak deskriptif dan tidak ada pemisah underscore

function fileProperties() // tidak deskriptif dan menggunakan huruf besar

function getfileproperties() // lebih deskriptif! Namun masih tidak menggunakan underscore sebagai pemisah

getFileProperties() // deskriptif! Namun menggunakan huruf besar

penulisan yang baik:

function get_file_properties() // deskriptif,    menggunakan underscore, dan huruf kecil semua.

  

• Penamaan Variabel

Penamaan variabel sering kita lakukan. Namun ternyata masih banyak dari kita yang masih asal-asalan dalam memberi nama pada variabel. Ada baiknya jika menamakan variabel kita mengikuti beberapa kaidah agar orang lain dapat lebih paham pada variabel yang kita buat. Dari contoh berikut saya harap Anda sudah bisa menarik kesimpulan tentang penulisan variabel yang baik.

Penulisan yang kurang baik:

$j = 'foo'; // untuk variabel 1 karakter, sebaiknya digunakan hanya untuk bahan perulangan saja

$Str // Salah karena terdapat huruf besar

$bufferedText // Terdapat huruf besar dan terlalu panjang

$groupid // jika terdapat lebih dari 1 kata, pisahkan dengan underscore

$name_of_last_city_used // Terlalu panjang

Saya akan memperbaiki masing-masing dari penulisan variabel diatas, sehingga akan seperti ini

Penulisan yang baik:

for ($j = 0; $j < 10; $j++)

$str

      $buffer

$group_id

$last_city

• Penulisan Konstanta

Penulisan konstanta yang baik sebenarnya hampir sama dengan penulisan variabel. Bedanya konstanta di tulis dengan huruf besar semua. Berikut adalah contoh penulisannya

Penulisan yang kurang baik:

myConstant // tidak ada pemisah underscore dan tidak di tulis huruf besar semua

N // konstanta tidak boleh singgel karakter

S_C_VER // Tidak deskriptif, sulit di pahami maksudnya

Masing-masing penulisan diatas saya perbaiki sehingga akan menjadi seperti ini.

Penulisan yang baik:

MY_CONSTANT

NEWLINE

SUPER_CLASS_VERSION

• Penulisan logika TRUE, FALSE, dan NULL

Penulisan logika TRUE, FALSE, dan NULL sebaiknya di tulis dengan huruf besar semua. Berikut perbandingan contoh penulisannya

Penulisan yang kurang baik:

if ($foo == true)

$bar = false;

function foo($bar = null)

Penulisan yang baik:

if ($foo == TRUE)

$bar = FALSE;

function foo($bar = NULL)

• Logika operator

Menggunakan simbol dalam penulisan logika operator dapat membuat rancu pada orang yang ingin memahami program kita. Misal penggunaan simbol ||  sebagai logika OR dapat membuat orang mengira itu angka 11.  Lalu apabila anda tanda !, usahakan setelah tanda ! ada spasi. Berikut contoh perbandingannya

Penulisan yang kurang baik:

if ($foo || $bar)

if ($foo AND $bar)

if (!$foo)

if (! is_array($foo))

Penulisan yang baik:

if ($foo OR $bar)

if ($foo && $bar)

( ! $foo)

if ( ! is_array($foo))

• Spasi Kosong

Jangan sampai ada spasi kosong pada awal pembukaan kode php.

Penulisan yang kurang baik

<?php

// ...ada spasi kosong dan baris kosong sebelum tag <?php

// as well as whitespace after the closing PHP tag

?>

      Penulisan yang baik

<?php

// dalam contoh ini tidak ada spasi kosong  sebelum dan sesudah tag php

?>

• ·         Spasi diantara tanda kurung

Perlu diperhatikan juga adanya spasi diantara tanda kurung dalam kode pogram. Sebaiknya jangan sampai ada spasi di dalam tanda kurung. Berikut perbandingan penulisannya

Penulisan yang kurang baik:

$arr[ $foo ] = 'foo';

Penulisan yang baik:

$arr[$foo] = 'foo'; // tidak ada spasi diantara tanda kurung

Berikut adalah contoh dalam penulisan fungsi

Penulisan yang kurang baik:

function foo ( $bar )

{

}

Penulisan yang baik:

function foo($bar) // tidak ada spasi dalam tanda kurung fungsi

{

}

• Penggunaan short tags

Penggunaan pasangan short tags seperti <? ?> atau <?= ?>memang simpel. Namun sebaiknya di hindari karena tidak semua server bisa menerima short tags. Lebih aman kalau kita menuliskannya lengkap. Berikut adalah contohnya

Penulisan yang kurang baik:

<? echo $foo; ?>

<?=$foo?>

Penulisan yang baik:

<?php echo $foo; ?>

• Satu pernyataan, satu baris

Sebaiknya satu pernyataan di letakan pada satu baris agar memudahkan dalam proses maitenance protgram dan kode pogram tidak kelihatan ruwet. Berikut adalah contohnya

Penulisan yang kurang baik:

$foo = 'this'; $bar = 'that'; $bat = str_replace($foo, $bar, $bag);

Penulisan yang baik:

$foo = 'this';

$bar = 'that';

$bat = str_replace($foo, $bar, $bag);

Sumber  : http://jagocoding.com/blog/630/Pedoman_Menulis_Kode_Program_PHP_yang_Baik