Semasa memprogram di komputer, kadang-kadang perlu meninggalkan nota atau komen supaya pembangun lain dapat melihat kod anda dengan mudah. Sama ada projek sumber terbuka atau projek hak milik, komen diperlukan untuk berkoordinasi dengan pembangun bersama dan juga pembangun masa depan. Tanpa komen, kod tidak dapat dikendalikan.
Langkah-langkah
Langkah 1. Fahami tujuan mengulas program komputer
- Kebolehbacaan adalah perkara utama di sini. Apabila anda melihat komen, anda harus tahu bahawa itu adalah komen dan bukan garis kod.
- Komen itu juga harus bermanfaat bukan hanya untuk anda, tetapi untuk orang lain yang mungkin membaca kod sumber program komputer anda.
Langkah 2. Fikirkan cara ringkas dan ringkas untuk mengetahui maksud anda
Komen tidak perlu menjadi karya seni. Mereka harus ringkas, rapi, dan langsung ke intinya.
Bagaimanapun, ini tidak boleh mendorong penggunaan beberapa baris untuk komen. Maksudnya ialah maklumat perlu disampaikan kepada pembaca
Langkah 3. Tulis komen menggunakan sintaksis yang sesuai yang diberikan oleh bahasa pengaturcaraan
Langkah 4. Tanyakan pada diri anda apakah komen yang anda tulis cukup terperinci
Komen harus dapat memberitahu seseorang yang melihat kod sumber apa yang sebenarnya dilakukan oleh bahagian program ini tanpa perlu menyusunnya dan menjalankannya. Adakah komen anda berjaya? Adakah ia menyampaikan semua perinciannya?