Langsung ke konten utama

Cara Efektif Menambahkan Komentar Pada Source Code

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.
Label:

Komentar

Posting Komentar

Postingan populer dari blog ini

Cara Efektif Menggunakan StringGrid

StringGrid merupakan salah satu VCL yang sangat berguna. Jika anda sudah familiar dengan Webbased Application, anda bisa analogikan StringGrid dengan Table. Table digunakan untuk meenampilkan data. Adapun StringGrid, selain sebagai komponen untuk menampilkan data, dia juga juga bisa sebagai tempat untuk memasukkan data, lihat gambar di bawah ini : Pada gambar di atas, saya menampilkan form jurnal umum sebagai contoh penggunaan StringGrid. Pada contoh di atas, stringgrid dipakai untuk memasukkan data item jurnal berupa Kode dan nama perkiraan, status Debet/Kredit dan Nominal. Untuk memanfaatkan Stringgrid saya mempunyai beberapa konstanta yang mencerminkan nomor urut kolom, misalnya _KolKode merujuk pada kolom Kode Perkiraan, _KolNama merujuk pada kolom Nama. Lebih jelasnya lihat baris kode berikut : Const _KolKode : Integer = 0; _KolNama : Integer = 1; _KolDK : Integer = 2; _KolNominal : Integer = 3; Konstanta-konstanta tersebut saya pakai di beberapa tempat. Diantaran...
4 komentar
Baca selengkapnya

Tanda-tanda programmer buruk

Dalam dunia pekerjaan, ada berbagai cara untuk menjadi tidak efektif. Berikut adalah beberapa perilaku yang sering terjadi pada beberapa programmer yang pernah saya kerjakan selama bertahun-tahun: "Saya Seorang Insinyur Perangkat Lunak, Bukan Programmer"  Anda tahu seperti apa mereka. Mereka membawa keyboard mekanis ke kantor? Mereka tidak bisa ikut dalam pertemuan harian karena terlalu sibuk memikirkan masalah tersebut (hanya butuh 5 menit untuk menyampaikan apa yang Anda pikirkan). Berapa lama waktu yang dibutuhkan untuk mendapatkan latte? Saya tidak begitu yakin bagaimana seseorang bisa menjadi begitu sombong dengan pengalaman 3 tahun, tapi begitulah adanya. Saya suka mengesankan orang dengan gelar pekerjaan saya. Siapa? Apa maksud Anda, tidak ada yang peduli. Mungkin sebaiknya Anda menghabiskan lebih banyak waktu untuk bekerja dan sedikit waktu untuk memikirkan status Anda? Papan Tulis di Belakang  Beberapa orang di industri ini memiliki gelar. Saya pernah bekerja deng...
Posting Komentar
Baca selengkapnya

Singleton Pattern

Motivasi Kadang ada keadaan di mana kita hanya boleh memiliki satu instan dari suatu kelas. Sebagai contoh, kita hanya boleh memiliki satu window manager (atau satu sistem file atau satu spooler printer) pada satu aplikasi. Biasanya singleton digunakan untuk managemen sumber daya internal maupun eksternal secara terpusat dan bisa diakses dimanapun. Singleton merupkan salah satu design pattern yang paling sederhana. Singleton hanya melibatkan satu kelas yang bertanggung jawab untuk menginstansiasi dirinya sendiri dan pada saat yang bersamaan menyediakan akses secara global terhadap instan tersebut. Pada pattern singleton, instan bisa diakses dari manapun tanpa harus memanggil contructor dari kelas instan tersebut Tujuan • Memastikan bahwa satu kelas hanya bisa dibuat instannya sekali. • Menyediakan akses secara global terhadap instan singleton tersebut. Implementasi Pada bahasa pemrograman Java, implementasi dari singleton adalah dengan membuat sebuah atribut static pada...
Posting Komentar
Baca selengkapnya