Saat memprogram di komputer, terkadang Anda perlu meninggalkan catatan atau komentar agar pengembang lain dapat menelusuri kode Anda dengan mudah. Baik itu proyek sumber terbuka atau proyek berpemilik, komentar diperlukan untuk berkoordinasi dengan pengembang bersama dan kemungkinan pengembang masa depan juga. Tanpa komentar, kode tidak akan bisa dipertahankan.
Langkah
Langkah 1. Pahami tujuan mengomentari program komputer
- Keterbacaan adalah hal utama di sini. Ketika Anda melihat komentar, Anda harus tahu bahwa itu adalah komentar dan bukan baris kode.
- Komentar juga harus bermanfaat tidak hanya untuk Anda, tetapi juga untuk orang lain yang mungkin membaca kode sumber program komputer Anda.
Langkah 2. Pikirkan cara singkat dan sederhana untuk menyampaikan maksud Anda
Komentar tidak perlu menjadi sebuah karya seni. Mereka harus ringkas, rapi, dan langsung ke intinya.
Namun, ini seharusnya tidak mencegah penggunaan beberapa baris untuk komentar. Intinya adalah bahwa informasi perlu sampai ke pembaca
Langkah 3. Tulis komentar menggunakan sintaks yang sesuai yang diberikan oleh bahasa pemrograman
Langkah 4. Tanyakan pada diri Anda apakah komentar yang Anda tulis sudah cukup detail
Sebuah komentar harus dapat memberi tahu seseorang yang melihat kode sumber apa yang sebenarnya dilakukan oleh bagian program itu tanpa harus mengompilasi dan menjalankannya. Apakah komentar Anda mencapai ini? Apakah itu menyampaikan semua detail?
