Cara Efektif Menambahkan Komentar Pada Source Code

Posted by dragon on Sunday, 9 October 2011

type='html'>
Dear Delphiers, pada artikel ini saya akan mencoba membahas bagaimana cara membuat komentar yang efektif pada source code aplikasi yang kita bangun. Saya sendiri merasa source code tanpa komentar bagaikan sayur tanpa garam. Ga sedap gitu lho ... : ). Tapi kalau kebanyakan komentar juga tidak bagus juga. Source code jadi kotor, semrawut, dan sulit dibaca. Ibarat sayur kebanyakan garam, ASIN !!

Di delphi, ada beberapa cara untuk membuat komentar. Yang pertama dengan menggunakan operator "//". Tanda ini akan menjadikan baris di sebelah kanannya tidak akan dieksekusi oleh compiler. Cara ini sangat cocok untuk menambahkan satu atau dua baris komentar saja. Cara kedua dengan mengapit komentar dengan kurung kurawal "{}" . Karakter yang berada diantara tanda "{}" tidak akan dieksekusi oleh compiler. Cara ini sangat efektif untuk menambahkan komentar yang cukup panjang.
Dalam menambahkan komentar, menurut saya, ada beberapa hal yang perlu diperhatikan
  • Seperlunya
Komentar pada source code memang sangat penting bagi pengembangan sebuah software. Apa lagi jika satu unit file dikerjakan lebih dari satu orang. Namun meskipun demikian, kita tetap harus berhati-hati dalam menambahkan komentar. Jangan sampai dengan banyaknya komentar malah akan membuat source code menjadi kotor dan sulit dibaca.

procedure TfrmPembayaran.FormCreate(Sender: TObject);
begin
inherited;
FPenyaluranDana := TPenyaluranDana.Create(Self);
FPembayaran := GenerateObjectPembayaran;
FJurnalUtip := TJournal.Create(Self);
end;


Menurut hemat saya, baris kode di atas tidak perlu anda kasih komentar. Baris kode di atas merupakan baris kode yang benar-benar jelas, yaitu melakukan instantsiasi dari kelas TPenyaluranDana, TPembayaran, dan TJournal. Apa yang membingungkan kan? Makanya tidak perlu diberikan komentar.

Namun demikian , jangan mudah untuk tidak memberikan komentar juga. Jika memang baris kode kita sulit dibaca lebih baik diberikan komentar secukupnya. Ingatlah, hari ini anda paham algoritma di baris kode anda, tapi belum tentu besok, minggu depan, bulan depan, atau tahun depan. Apalagi bagi orang lain yang kebagian tugas membetulkan bug pada source code anda, sedangkan anda sudah tidak ada.
  • Jangan Terlalu Banyak Memberikan Komentar
Poin dua ini sebenarnya melengkapi poin pertama. Bahasa delphi terkenal akan mudahnya dipelajari. Hal ini karena mudahnya cara membaca source code delphi. Jadi, hendaknya kita bijak dalam menambahkan komentar.
  • Cara Cepat Menambahkan komentar
Di delphi 10 dan versi setelahnya, ada cara mudah memberikan komentar. Anda tinggal mem-blok baris yang akan dijadikan komentar lalu tekan tombol "Ctrl+/". Jika cara ini belum berhasil, anda bisa menggunakan program tambahan baik yang free maupun berbayar. CnPack atau Model Maker Explorer (MMX) adalah contoh program tambahan yang perlu anda pertimbangkan di komputer anda.

{ 0 comments... read them below or add one }

Post a Comment