Kode yang berkualitas?

Berdasarkan standar kualitas kode yang kita pakai dalam pembuatan project, ada beberapa standar-standar penulisan kode yang sebaiknya selalu diperhatikan. Saya selalu bertentangan dengan begitu banyak aturan dasar dari software yang berkualitas dan selalu... Seringkali saya merasa bosan untuk menulis komentar (comment), seringkali saya gagal untuk mengecek nilai kembalian (return value) dari sebuah fungsi, saya seringkali memulai dengan menulis kode sebelum saya sanggup mendesainnya. Kebanyakan dari kita mungkin sudah tahu aturan dasar dari pengkodean yang ‘baik’, tapi saya tetap ingin menuliskannya disini.


Komentari kode kita.


  • Seseorang (siapa saja) menulis “Jika kita tidak bisa menjelaskannya dalam kode, jelaskanlah dalam komentar (comment). Jika kode belum bersih, susah atau panjang, tulis komentar untuk menjelaskan mengapa demikian.

  • Buat mudah. Komentar yang baik bisa saja hanya terdiri dari beberapa kata atau paragraf. Kuncinya adalah membuatnya mudah dan mengomentari tujuan penting yang kita buat.

  • Perhatikan, bahwa dalam pemeliharaan program kita jangan sampai melupakan untuk mengomentari kode kita. Kita merawat kode, jadi jika kita menuliskan komentar seperti “’a=b”, kadangkala kode kita akan berubah menjadi a=c, tapi komentar akan selalu menjadi “’a=b”. Jadi jangan mengomentari yang sudah sewajarnya.


Validasikan input dari fungsi



  • Sangat baik dalam mendebug kode dan memperoleh hasil dari dialog yang tampil atau tracing yang dilakukan sampai output program keluar dan memberitahu saya apa saja yang salah sebelum program itu dirilis.

  • Pelajari bagaimana menggunakan Try Catch.

  • Validasikan dalam build release.


Mengecek kembalian dari suatu fungsi



  • Mengecek kembalian dari suatu fungsi

  • Ketahui nilai apa yang dikembalikan dan kenapa?

  • Dalam kode, periksa tiap nilai kembalian dari suatu fungsi.

  • Periksa nilai kembalian dari fungsi-fungsi yang tidak diharapkan. Jika suatu fungsi bisa mengembalikan 1,2,3 atau 4, coba buatkan untuk fungsi itu agar mengembalikan beberapa kode yang lain. Maka, jika kita menggunakan pernyataan switch, masukkan juga cabang standarnya agar bisa mengelak dari nilai kembalian yang tidak diharapkan.


Inisialisasikan variabel


  • Bila memungkinkan, inisialisasikan suatu variabel ke dalam nilai yang sebenarnya, bukan nilai bantuan (cth : daripada menulis dim x as integer = 0, x=GetFunction(), tulislah dim x as integer=GetFunction().

  • Jika nilainya tidak ada, inisialisasikan nilainya ke angka NOL, Nothing atau lainnya.


Tangkap kesalahan pada lokasi yang tepat


  • Ketahui kira-kira fungsi apa yang akan memiliki kesalahan.

  • Kegagalan dalam menangkap kesalahan bisa berakibat pada memori.

  • Jika kita tidak menangkapnya, kita akan kehilangan kontrol terhadap sistem kita sendiri.


Gunakan pengawas


  • Sangat baik untuk aplikasi server-side back-end yang harus selalu aktif dalam 24 jam selama 7 hari.


Tracing itu baik


  • Trace memberikan programmer kesempatan untuk melakukan pengamatan secara detail tanpa mengganggu alur program.

  • Trace bisa digunakan pada build release bila dibutuhkan.


Berpikirlah bahwa kode kita memiliki kekurangan


  • Banyak kode tidak selalu berarti baik.

  • Gunakan kembali kode bila memungkinkan, menggunakan derivation, consolidation, delegation atau apapun..

  • Setiap baris kode yang kita tulis pasti rawan terhadap bugs dan perubahan.


Penamaan


  • Berikan nama yang berarti untuk semua fungsi, class, struktur, variabel, constant, macro dll.

  • Cobalah menggunakan ketetapan penamaan standar untuk project kita.




Related Posts by Categories



Widget by Hoctro

Enter your email address:

Delivered by FeedBurner

Followers



Source Code