Inilah 5 Tips Menulis Source Code Yang Baik

Inilah 5 Tips Menulis Source Code Yang Baik

Bukan hanya isi programnya saja yang perlu diperhatikan seorang programmer tetapi juga cara penulisannya. Penulisan kode program yang baik akan tidak berantakan, dapat dipahami, mudah dilihat, memberi kemudahan membaca alur dan sebagainya sehingga ketika suatu saat kita membuka ulang program, kita akan mudah memahaminya. Berikut hal-hal yang perlu diperhatikan dalam menulis kode program.

1. Perhatikan Format 

Dalam penulisan kode program, Anda harus memperhatikan format penulisan yang akan membuat pembaca mudah dan cepat memahami alurnya. Berikanlah indentasi yang konsisten di dalam kode program untuk membuat hubungan yang jelas antara kode blok, kelas, fungsi, serta loop dari mana mereka berasal.  Berikut contoh penulisan kode program yang buruk:


Penulisan kode program yang baik : 

2. Pemberian Komentar / Dokumentasi
Jika suatu saat nanti Anda membuka program Anda kembali, adakalanya Anda lupa dan butuh waktu untuk mengingat kode program yang telah Anda tulis. Maka dari itulah, penting bagi Anda untuk menulis komentar pada program saat Anda menulisnya. Namun, Anda sebaiknya tidak menulis komentar secara berlebihan ataupun terlalu sedikit serta tidak perlu bagi Anda menulis komentar untuk suatu baris program yang sudah jelas ataupun umum diketahui. Selain itu, ketika satu baris saja sudah cukup menjelaskan suatu bagian program, Anda tidak perlu menambah komentar lagi. Aturannya adalah seperti di berikut :
1.  Penjelasan sebelum prosedur/fungsi tentang apa yang dilakukannya.
2.  Sebuah deskripsi nilai yang berlaku di sebuah proses.
3.  Jika itu fungsi, sebuah deskripsi tentang apa nilai kembalinya.
4.  Didalam prosedur/fungsi, beri komentar yang membagi kode menjadi tugas yang lebih pendek.
5.  Untuk potongan kode yang cukup sulit, beri penjelasan singkat tentang apa yang terjadi.

3. Penggunaan #define
Untuk mendefiniskan sesuatu nilai yang bernilai default, sebaiknya kita menggunakan #define. Hal itu lebih baik daripada kita menuliskannya secara manual ke beberapa bari program yang menggunakannya. Sebagai contoh untuk memasukkan nilai PI, dapat ditulis :

#define PI 3.14159
Kemudian untuk memanggil nilai PI, dapat dituliskan seperti :

4. Konsisten Dalam Penulisan
Dalam penulisan kode program, Anda harus konsistem dalam penamaan variabel, namespace case sensitive, dan ukuran agar mudah dipahami. Untuk penulisan namespace ada dua cara yaitu semua huruf pertama dari setiap kata dikapitalisasi kecuali kata pertama seperti kataSatu atau digunakan underscores (garis bawah) seperti kata_satu. Untuk sesuatu yang bernilai default penulisannya menggunakan huruf kapital semua seperti PI, MAXIMUM_VALUE. Sedangkan untuk kelas, setiap huruf pertama dari setiap kata dikapitalisasi seperti Atom, TestJawaban,.
5. Gunakan Prinsip DRY ( Don't Repeat Yourself)
Yang dimaksud dengan prinsip DRY adalah kita tidak perlu menuliskan bagian kode program yang secara berulang-ulang. Adakalanya, ada suatu bagian program yang dipakai berulang di beberapa bagian program lain. Untuk itu kita perlu memisahkan bagian kode program tersebut ke file baru, dan memanggilnya di program-program yang membutuhkannya. Sebagai contoh penggunaan header dan footer yang selalu sama di setiap halaman, seperti contoh kode program di CodeIgniter di bawah ini :
$this->load->view('includes/header');
$this->load->view($main_content);
$this->load->view('includes/footer');

(uli)

       


NAMA PESERTA TEST & PENERIMA BEASISWA

  
  
Loading...



12 October 2016 ADMIN Bagikan di Twitter Bagikan di Facebook Bagikan di Google+ Bagikan di Google+

Artikel menarik lainnya



Previous Post Trik Memberikan Keamanan Pada File PDF Anda Dengan Nitro Pro Next Post Trik Windows 10 Yang Perlu Kamu Ketahui