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

Object Oriented Programming (OOP) Pada Delphi - Bag 1

Object Pascal, adalah sebuah bahasa dimana delphi menjadi salah satu IDE (Integrated Development Environment) nya, adalah sebuah bahasa yang mendukung penuh konsep OOP. Sederhananya, bahasa ini memungkinkan bagi programmer untuk membuat dan memanipulasi object. Lebih detailnya, bahasa ini mendukung empat prinsip pokok OOP yaitu : Data Abstraction, Encapsulation, Inheritance, Polymorphism. Mempelajari OOP berbeda dengan mempelajari Delphi. Apalagi bagi seorang yang sudah mengenal bahasa Pascal. Bisa jadi ada orang yang sangat mahir delphi/pascal namun sangat lemah pada konsep OOP. Apa itu OOP? Apa Itu Object? Apa Itu Kelas? OOP adalah semua hal yang berkaitan dengan writing programs that manipulate objects : ). Delphi, Java, C++ adalah beberapa contoh bahasa yang mendukung OOP. Ketiga bahasa di atas mempunyai prinsip-prinsip OOP yang sama, tentunya dengan sintaks (penulisan baris kode program) yang berbeda. Sekali kita sudah menguasai konsep OOP, maka akan begitu mudah mempelaja...
4 komentar
Baca selengkapnya

Menambahkan Function Pada Fast Report

Fast report merupakan salah satu reporting tool yang banyak dipakai oleh para developer delphi. Fast Reprt menyediakan built-in function yang sangat memudahkan kita dalam membuat sebuah laporan. Namun adakalanya kita membutuhkan function/procedure yang tidak ada pada built-in function bawaan fast report. Oleh karena itu kita harus menambahkan sendiri. Untuk menambahkan function pada fast report kita perlu membuat kelas yang diturunkan dari TfsRTTIModule. Lebih jelasnya lihat baris kode berikut ini : unit uTSFastReportFunction; interface uses SysUtils, Classes, fs_iinterpreter, Forms; type TTSFastReportFunction = class(TfsRTTIModule) private function CallMethod(Instance: TObject; ClassType: TClass; const MethodName: String; var Params: Variant): Variant; public constructor Create(AScript: TfsScript); override; function Quot(AString : String): String; end; const _Kategori : string = 'My Functions'...
2 komentar
Baca selengkapnya