Bagikan melalui

Komentar dalam Kode (Visual Basic)

Saat Anda membaca contoh kode, Anda sering menemukan simbol komentar ('). Simbol ini memberi tahu pengkompilasi Visual Basic untuk mengabaikan teks yang mengikutinya, atau komentar. Komentar adalah catatan penjelasan singkat yang ditambahkan ke kode untuk keuntungan dari mereka yang membacanya.

Adalah praktik pemrograman yang baik untuk memulai semua prosedur dengan komentar singkat yang menjelaskan karakteristik fungsi dari prosedur (apa yang dilakukannya). Ini untuk keuntungan Anda sendiri dan manfaat orang lain yang memeriksa kode. Anda harus memisahkan detail implementasi (bagaimana prosedur melakukannya) dari komentar yang menjelaskan karakteristik fungsional. Saat Anda menyertakan detail implementasi dalam deskripsi, ingatlah untuk memperbaruinya saat Anda memperbarui fungsi.

Komentar dapat mengikuti pernyataan pada baris yang sama, atau menempati seluruh baris. Keduanya diilustrasikan dalam kode berikut.

' This is a comment beginning at the left edge of the screen.
text1.Text = "Hi!"   ' This is an inline comment.

Jika komentar Anda memerlukan lebih dari satu baris, gunakan simbol komentar di setiap baris, seperti yang diilustrasikan contoh berikut.

' This comment is too long to fit on a single line, so we break 
' it into two lines. Some comments might need three or more lines.

Panduan Mengomentari

Tabel berikut ini menyediakan panduan umum untuk jenis komentar apa yang dapat mendahului bagian kode. Ini adalah saran; Visual Basic tidak menerapkan aturan untuk menambahkan komentar. Tulis apa yang paling sesuai, baik untuk Anda maupun bagi orang lain yang membaca kode Anda.

Jenis komentar Deskripsi komentar
Tujuan Menjelaskan apa yang dilakukan prosedur (bukan bagaimana prosedur melakukannya)
Asumsi Mencantumkan setiap variabel eksternal, kontrol, file terbuka, atau elemen lain yang diakses oleh prosedur
Efek Mencantumkan setiap variabel eksternal, kontrol, atau file yang terpengaruh, dan efek yang dimilikinya (hanya jika tidak jelas)
Masukan Menentukan tujuan argumen
Pengembalian Barang Menjelaskan nilai yang dikembalikan oleh prosedur

Ingat poin-poin berikut:

  • Setiap deklarasi variabel penting harus didahului oleh komentar yang menjelaskan penggunaan variabel yang dideklarasikan.

  • Variabel, kontrol, dan prosedur harus diberi nama yang cukup jelas sehingga komentar hanya diperlukan untuk detail implementasi yang kompleks.

  • Komentar tidak dapat mengikuti urutan kelanjutan baris pada baris yang sama.

Anda dapat menambahkan atau menghapus simbol komentar untuk blok kode dengan memilih satu atau beberapa baris kode dan memilih tombol Komentar (Komentar Visual Basic di Visual Studio.) dan Hapus Komentar (tombol Hapus Komentar Visual Basic di Visual Studio.) pada toolbar Edit .

Nota

Anda juga dapat menambahkan komentar ke kode Anda dengan mendahului teks dengan REM kata kunci. Namun, simbol ' dan tombol Komentar/Uncomment lebih mudah digunakan dan membutuhkan lebih sedikit ruang dan memori.

Lihat juga