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.
Baca selengkapnya...

Elemen Dasar PHP

Elemen Dasar PHP

Sebagai pembuka, posting blog pertama ini akan mengajak Anda mengenal lebih dekat elemen-elemen PHP. elemen yang dimaksud meliputi autran-aturan dasar, sintaks, dan fitur bahasa. Mengingat peran penting elemen-elemen ini sebagai salah satu komponen fundamental dalam pembuatan aplikasi, maka sudah sepatutnya kita memahaminya secara baik dan benar.


Standar Pengkodean

Pada umumnya, setiap bahasa pemrograman mendefinisikan aturan-aturan standar yang dimaksudkan untuk dijadikan sebagai acuan bagi programmer. Dengan mengikuti aturan-aturan tersebut, kita dapat menghasilkan kode program yang konsisten dan seragam. Seabgai acuan, berikut akan dijelaskan mengenai beberapa aturan standar yang disarankan.

Standar Penamaan
Di dalam pemrograman, suatu nama digunakan untuk mengacu ke entitas yang dideklarasikan. Terkait hal ini, ada beberapa aturan dasar penamaan yang perlu sekali diperhatikan dalam upaya menghasilkan kode program yang readable.
Penamaan variable sebaiknya dituliskan menggunakan huruf kecil semua. Apabila nama terdiri atas beberapa kata, pisahkan dengan garis bawah (underscore). Sebagai contoh, $nama atau $nama_user.
Penamaan konstanta disarankan mengikuti aturan variabel, kecuali di sini menggunakan hruf besar semua, misalnya MAX, MAX_DATA atau JML_DATA.
Penamaan fungsi sebaiknya juga mengacu pada penamaan variable, dan sangat disarankan agar mencerminkan suatu aksi atau kata kerja, misalnya:
get_data(){
  //fungsi untuk mengambil data
}
set_data(){
  // fungsi untuk menulis data
}
atau
print_data(){
  // fungsi untuk mencetak data
}
Baca selengkapnya...