Kode yang baik dibaca berkali-kali lebih sering daripada ditulis. Pembaca kode bukan hanya kita hari ini, tetapi juga rekan kerja atau kita sendiri enam bulan kemudian. Komentar memungkinkan kita menyisipkan catatan untuk manusia di dalam file yang oleh compiler diabaikan sepenuhnya. C# menyediakan tiga bentuk komentar dengan kegunaan berbeda.

Komentar Satu Baris dan Komentar Blok #

Komentar satu baris diawali // dan berlaku sampai akhir baris. Komentar blok diawali /* dan berakhir di */, sehingga boleh membentang beberapa baris.

csharp 
// Program kecil untuk menyapa pengguna

Console.WriteLine("Selamat datang di Belajar C#"); // sapaan pembuka
/* Blok komentar ini tidak dieksekusi.
   Cocok untuk catatan panjang. */
Console.WriteLine("Komentar tidak memengaruhi output");

Output yang Dihasilkan:

text 
Selamat datang di Belajar C#
Komentar tidak memengaruhi output

Mari kita telaah baris demi baris:

  1. Baris 1 (// Program kecil ...): Satu baris penuh menjadi komentar; compiler melewatinya tanpa memproses apa pun.
  2. Baris 3 (Console.WriteLine(...) // sapaan pembuka): Statement tetap dieksekusi normal; hanya teks setelah // di akhir baris yang diabaikan.
  3. Baris 4-5 (/* ... */): Kedua baris berada di dalam komentar blok sehingga tidak memengaruhi jalannya program.
  4. Baris 6: Statement terakhir dieksekusi karena sudah berada di luar blok komentar.

Komentar Dokumentasi XML #

Bentuk ketiga diawali tiga garis miring (///) dan disebut XML documentation comment. Bentuk ini punya fungsi tambahan: editor seperti Visual Studio membaca komentar /// dan menampilkannya sebagai petunjuk saat kita mengetik nama method dari pustaka.

csharp 
/// <summary>Menampilkan sapaan pembuka ke console.</summary>
Console.WriteLine("Selamat datang di Belajar C#");

Output yang Dihasilkan:

text 
Selamat datang di Belajar C#

Kita belum menulis method sendiri di tahap ini, tetapi mengenali bentuk /// berguna saat membaca kode pustaka yang kebanyakan memakainya.