Sabtu, 02 Juli 2011

Indentasi

Masih dalam topik Standar Pengkodean pada Elemen Dasar PHP, kali ini saya akan membahas tentang:
  1. Indentasi,
  2. Pemformatan Kode Program,
  3. Konsistensi, dan
  4. Dokumentasi Program.
Indentasi
Untuk menghasilkan kode program yang rapi dan mudah dibaca, gunakan indentasi. Langkah ini bisa dilakukan menggunakan tab atau spasi (biasanya empat spasi).
Saya sendiri biasanya menggunakan dua spasi dengan tujuan "menghemat" size kode yang nantinya dihasilkan.

// Tanpa indentasi
if (is_valid()){
return false;
}

if (is_valid()){
  return true;
}
Pemformatan Kode Program
Hindari kode yang memanjang dalam satu baris untuk memudahkan penelusuran kode program. Sebagai solusinya, format kode program dengan menguraikan bagian-bagiannya.
// Susah ditelusuri
if ($vokal == 'a' || $vokal == 'i' || $vokal == 'u' || $vokal == 'e' || $vokal == 'o'){
  $huruf = "Huruf Vokal";
}
// Mudah ditelusuri
if ($vokal == 'a' || $vokal == 'i' || $vokal == 'u' || 
    $vokal == 'e' || $vokal == 'o')
{
    $huruf = "Huruf Vokal";
}
Sebagai tambahan, sebaiknya selalu gunakan spasi untuk merapikan kode program.
$bahasa = 'php';
$kategori = 'pemrograman';
$url = 'http://www.php.net';
// Apabila diperlukan anda dapat meluruskan assignment variable sehingga menjadi lebih rapi
$bahasa   = 'php';
$kategori = 'pemrograman';
$url      = 'http://www.php.net';
Konsistensi
Penulisan kode yang konsisten menjadikan kode program lebih mudah dibaca dan dipahami maknanya.
Apabila variable digunakan untuk tujuan yang sama, sebaiknya diberikan nama yang serupa juga. Contohnya, jika variable $jml digunakan untuk menyatakan suatu jumlah, maka usahakan untuk selalu menggunakan nama ini seterusnya dalam kode program Anda.
Jadi, maksud konsistensi disini adalah jangan memberikan nama yang berbeda untuk tujuan yang serupa. Misalnya $jum, $jumlah atau $total.
Untuk penggunaan di suatu blok, Anda bisa mendeklarasikan variabel dengan prefix / awalan yang sama, misalnya $jml_data, $jml_max, $jml_min. Meskipun kelihatan susah untuk diterapkan, sebaiknya kita berupaya untuk menjaga konsistensi karena hal ini dapat meminimalisasi kerancuan penamaan.
Dokumentasi Program
Dokumentasi program diklasifikasikan ke dalam dua bagian, yaitu baris komentar dan dokumentasi API. Pada posting ini saya hanya akan membahas baris komentar, sedangkan untuk dokumentasi API akan dijelaskan pada posting selanjutnya.
Bahasa PHP mendukung tiga jenis sintaks untuk menuliskan baris komentar yaitu style C, C++ dan Perl/Shell.
/*
Komentar style C
*/

// Komentar style C++

# Komentar style Perl/Shell
Meskipun ketiga jenis style komentar diatas valid, namun usahakan untuk memilih style yang paling sesuai untuk kode program Anda. Umumnya, style C digunakan untuk komentar yang terdiri dari beberapa baris.

Tidak ada komentar:

Posting Komentar