Kriteria-kriterian Penulisan Kode Program yang Baik

menulis

Menulis atau tepatnya mengetik kode program adalah pekerjaan yang memerlukan perhatian khusus tentang baik atau tidaknya hasil penulisan kode kita tadi, karena dengan kode program yang ditulis dengan aturan yang baik maka kita akan mudah untuk melakukan pengubahan maksud, logika dan lain sebagainya.

Menurut bahan yang membahas hal ini pada http://www.cs.uky.edu/∼raphael/checklist.html (sekarang sudah tidak ada) dan penjelasan dosen ( Dwi Sakethi ) dapat diketahui beberapa hal yang perlu diperhatikan agar kode program yang telah kita tulis nantinya dapat dinilai baik. Kriterian-kriterianya adalah sebagai berikut : ( ditulis dengan gaya bahasa sendiri, pengertian saya sendiri, pengertian dosen, dan bersifat kalimat perintah )

1. Buatlah nama variabel itu bermakna
sebagai contoh pada php : $x; (kurang bermakna) $nama; (lebih bermakna), hal ini akan memudahkan kita mengingat fungsi-fungsi dari variabel yang kita buat.
Jika nama variabel yang akan dibuat terdiri dari 1 kata, maka dapat digabungkan dengan tanda underscore ‘_’ atau dibuat gaya Onta (merundak-undak) dan tidak boleh terpisah, contoh :
$nama_saya; (boleh) atau $NamaSaya; (boleh) $nama saya; (tidak boleh)

2. Hindarilah penggunaan magic number dan magic word
Hanya ada 2 angka (number) yang boleh ada di dalam penulisan kode setelah pendefinisian variabel, yaitu 0 (nol) dan 1 (pada tipe integer,dkk) , jika ada angka selain itu maka disebut magic number. Berlaku pula pada string atau char yaitu jika ada huruf atau karakter yang tidak didefinisikan terlebih dahulu,maka disebut magic word / string. Jika anda memerlukan angka lain, maka definisikan terlebih dahulu pada saat mendefinisikan variabel (yang biasanya terletak di atas / awal penulisan kode program kita).
Contoh pada php:
Kita tidak boleh melakukan hal ini :

$mulai;

for($mulai=1;$mulai<=30;$jumlah++) { echo"hai"; }
//(terdapat magic number yaitu angka 30 pada kode, angka 1 boleh saja)

//Seharusnya kita membuatnya seperti ini :
$mulai; $maksimal=30;

for($mulai=1;$mulai<=$maksimal;$mulai++) { echo"hai"; }

Aturan seperti ini dimaksudkan agar pada tulisan kode, kita lebih mudah untuk melakukan pengubahan nilai. Bayangkan jika kita telah melakukan penulisan loping yang terdapat magic number itu sebanyak puluhan kali dan kita akan mengubah nilai 30 menjadi 20 , tentunya kita akan memerlukan waktu yang lebih panjang dari pada kita mendefinisikannya terlebih dahulu pada $maksimum=30; kita hanya memerlukan penggantian 1 kali saja pada $maksimal=20;.
Demikian berlaku pula untuk variabel bertipe string atau karakter, maka harus didefinisikan terlebih dahulu. contoh $nama=”Abdullah”;
Tentunya tidak termasuk magic string jika itu berupa kalimat, konteks panjang berupa paragraf, kita bisa menggunakan prusedure untuk membuat konteks kalimat yang panjang.

3.Buatlah program kita menjadi modular
Membuat menjadi modular diartikan membuat program kita menjadi sub-sub program. Seperti penggunaan fungsi, prosedur, class dan lain sebagainya.
Hal ini akan memudahkan kita saat akan mengubah maksud, logika dan lain-lain dan tentunya program kita jadi terlihat lebih indah.
Contoh pada C++ :

void header(){
clrscr(); //void itu sejenis fungsi
cout<<"program ini dibuat oleh: Syaiful Fajri \n";
cout<<"NPM 0817032047\n";
cout<<"e-mail: syaiful.debian@gmail.com \n";
cout<<"Ilmu Komputer, Uiversitas Lampung, 2010\n";

cout&lt;&lt;"================================Dibawah lisensi GPL=\n";
} //akhir void header

setelah itu maka header dapat dipanggil dengan perintah :

int main(){
header(); // memanggil void header
}

4. Buatlah dokumentasi penulisan program
Biasakanlah untuk membuat keterangan tentang siapa pembuat program, kapan dibuat, dalam keadaan apa, dan lain-lain. Hal ini harus dilakukan pula saat “umpama” kita melakukan pengubahan kode atau modifikasi kode-kode yang bersifat GPL yang bebas kita ubah, maka kita harus menyantumkan identitas kita, disamping identitas pembuat program sebelumnya.
Contoh pada C++:
Tulisan murni punya kita :

// Program ini dibuat oleh Abdullah pada Ahad,pukul 9 pagi,
// Tanggal 30 Maret 2010
// Surat elektronik Saya_Abdullah@bla2.net
// Saya senang menulis program ini
int main () { cout<<"Ipsum lorem";}
Tulisan dari orang lian yang telah kita ubah;

// Program ini dibuat oleh Abdullah pada hari Senin ,pukul 9 pagi,
// Tanggal 30 Maret 2010
// Surat elektronik Saya_Abdullah@bla2.net
// Saya senang menulis program ini
// Program ini diedit oleh Azam pada hari Jumat, pukul 9.10 malam,
// Tanggal 3 Mei 2010
// Surat elektronik Azam12@bl2.net
// Azam juga senang mengubah program ini
int main () { cout<<"Ipsum lorem \n lorem ipsum";}

Hal ini akan sangat berguna untuk mengetahui hasil tulisan siapa program ini.

5. Buatlah komentar pada setiap baris yang maksudnya berbeda
Membrikan komentar pada setiap baris akan mempermudah kita atau orang lain untuk mengartikan maksud kode yang kita tulis.
Contoh :
pada php :

$tulisan="php"; //mendefinisakan variabel dan nilai awal

pada perl :

my $tulisan="perl"; #mendefinisikan variabel dan nilai awal

6. Hindari penulisan program melebihi 80 spasi / kolom pada satu baris program
Ini adalah alasan historis (kata dosen) dan sedikit keren. Layar-layar CRT zaman dahulu dan sekarang, layar editor seperti notepad++, dos, konsol Linux (menggunakan vi, dll), dan gedit umumnya hanya membuat lebar layarnya (dengan satuan kolom) selebar 79 — 80 kolom saja. Jadi untuk memastikan tuilsan kita terlihat pada layar, maka gunakan maksimal 79 (baiknya) kolom  yang digunakan untuk menulis program kita. Memang tidak mustahil jika kita mengubah ukuran lebar layar, namun jika yang membuka tulisan program itu orang lain (dosen,dll) dan orang lain tersebut hanya melihat tulisan kita hanya sebatas yang dapat dia lihat (maksimal 80 kolom), tanpa melihat kemungkinan ada tulisan kode lain di kolom lebih dari 80. Hmm…. alhasil kata anak Stan pasti apa kata dunia, dan kata anak ilkom, informatika pasti aduh nilai ku sambil berharap pak dosen mau berbaik hati melebarkan layar konsol, dos nya !….
Namun jika tulisan kode kita menuntut panjang, maka carilah literasi untuk menyambungkan kode kita ke baris selanjutnya, ini berbeda-beda pada setiap bahasa pemrograman.

Itulah penjelasannya, semoga bermanfangat dan lebih memudahkan kita dalam menuliskan kode program.
Ayo kasih komen atau menambahi !

4 Responses to “Kriteria-kriterian Penulisan Kode Program yang Baik”


  1. 1 abrari April 15, 2010 at 2:15 pm

    Penulisan kode yg baik yo? Aku pernah baca judulnya “C elements of style”. Keren pul…

  2. 3 bloksaya April 17, 2010 at 2:54 am

    hai, ini saya


Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google photo

You are commenting using your Google account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s




i'm a Ubuntu Partner"
Blue Ubuntu
Download Ubuntu 10.04 LTS


Download Ceramah Agama IslamKajian.Net

Blog Teman SMA N 1 Metro



Abrar
Albadr
Dea
Ferdian
Firli
Khafidz
Rizqy
This site uses Thumbshots previews

%d bloggers like this: