komentar

Apa itu Komentar

Komentar adalah teks penjelasan yang ditambahkan di dalam kode agar pemrogram lebih mudah memahami logika program. Komentar bukan bagian dari kode yang dapat dieksekusi, kompiler akan mengabaikan seluruh isi komentar saat proses kompilasi berjalan.

Komentar juga berguna saat kita melacak kesalahan program. Jika muncul error namun kita tidak tahu bagian mana yang bermasalah, kita bisa menutup sementara kode yang dicurigai pakai komentar; kompiler akan melewatkan kode tersebut sehingga kita bisa mencari sumber bug secara bertahap.

Komentar mirip dengan catatan tambahan yang kita tulis di buku pelajaran sewaktu sekolah, catatan ini membantu kita lebih cepat mengerti isi teks utama.

Jenis-Jenis Komentar

Jenis Komentar	Tanda Awal	Tanda Akhir	Aturan Utama
Komentar Satu Baris Single-line	//	Akhir baris saat ini	Hanya berlaku untuk satu baris penuh, semua tulisan setelah // di baris yang sama akan diabaikan
Komentar Blok (Terpisah) Delimited	/*	*/	Bisa mencakup banyak baris atau potongan kode di tengah baris, tidak boleh bersarang
Komentar Dokumentasi Documentation	///	Akhir baris saat ini	Mendukung tag XML bawaan, dipakai untuk membuat dokumen API proyek secara otomatis

1. Komentar Satu Baris //

1. Semua tulisan mulai dari simbol // hingga ujung baris sekarang akan dilewati kompiler;
2. Bisa ditulis di awal baris atau di belakang kode program;
3. Tidak ada batasan soal susunan bersarang, tidak akan terjadi bentrok sintaks dengan komentar blok /* */.

// Komentar di awal baris: mendeklarasikan variabel bilangan bulat
int num = 10; // Komentar setelah kode: menyimpan angka 10
// int temp = 99; // Seluruh baris ditutup komentar untuk debugging; menonaktifkan kode sementara tanpa menghapus, mudah dipulihkan nantiCode language: JavaScript (javascript)

2. Komentar Blok /* */

1. Memerlukan pasangan tanda awal dan akhir, semua konten di antara /* dan */ akan diabaikan;
2. Mendukung pencakupan banyak baris dan penutupan potongan kode di tengah baris;
3. Komentar blok dilarang bersarang. Kompiler akan mengakhiri komentar saat pertama kali bertemu simbol */, simbol */ yang tersisa tanpa pasangan akan menimbulkan kesalahan sintaks.

Contoh dasar

/*
Contoh komentar blok multi-baris
Semua tulisan di sini dilewati kompiler
Bisa menulis penjelasan sepanjang apapun
*/
string str = "Uji Coba";Code language: JavaScript (javascript)

/*
Multi-line delimited comment example
All content here is ignored by the compiler
Text can span any number of lines
wellcome to foxdevelop.com
*/
string greet = "wellcome to foxdevelop.com";
Console.WriteLine(greet);Code language: JavaScript (javascript)

Jika dibuat bersarang akan muncul error

Menulis komentar blok di dalam komentar blok lain akan membuat tanda tutup terakhir tidak memiliki pasangan tanda buka, sehingga program gagal dikompilasi.

Komentar Potongan Di Tengah Baris

Hanya menutup sebagian kode, variabel a pada contoh di bawah tertutup komentar.

int /*a,*/ b; 
// Sama dengan tulisan int b; bagian a, di tengah terabaikan oleh kompilerCode language: JavaScript (javascript)

Contoh Komentar Blok Bersarang yang Salah

Akan muncul pesan kesalahan

/* Mulai komentar luar
    /* Komentar dalam bersarang (hanya dianggap teks biasa, tidak berfungsi) */
// Simbol */ pertama di atas langsung menutup komentar luar, simbol */ di bawah tidak ada pasangan buka sehingga error sintaks
*/Code language: JavaScript (javascript)

Simbol /* di dalam // tidak membuka komentar blok

Simbol komentar blok tersebut menjadi bagian teks komentar satu baris dan tidak berfungsi.

// Ini komentar satu baris /* tulisan /* di sini hanya teks biasa, tidak akan membuka blok komentar
int x = 5;
/* Membuka komentar blok */ // Blok selesai di sini, simbol // setelahnya berfungsi normalCode language: JavaScript (javascript)

3. Komentar Dokumentasi ///

1. Bentuknya mirip komentar satu baris, pakai tiga garis miring berurutan ///;
2. Dapat menyisipkan tag XML, IDE atau tools bisa membacanya untuk membuat dokumen panduan API otomatis;
3. Biasanya ditulis di atas kelas, metode dan properti untuk menjelaskan antarmuka yang dibuka ke luar.

/// <summary>
/// Kelas utama titik masuk program
/// </summary>
class Program
{
    /// <summary>
    /// Metode awal jalannya program
    /// </summary>
    /// <param name="args">Array argumen baris perintah</param>
    static void Main(string[] args)
    {

    }
}Code language: JavaScript (javascript)

Ringkasan

1. Komentar blok /* */ tidak bisa bersarang, kompiler langsung mengakhiri komentar saat bertemu */ pertama;
2. Komentar satu baris // hanya aktif di baris yang sama, tidak melintasi baris lain; tulisan /* di dalamnya hanya dianggap huruf biasa;
3. Sintaks dan perilaku komentar satu baris serta blok di C# sama persis dengan C/C++;
4. Prinsip menulis komentar: jangan mengulang-ulang makna harfiah kode, utamakan penjelasan tujuan bisnis kode dan ide perancangan agar mudah dipelihara di masa depan. Komentar yang hanya menyalin nama variabel tidak ada gunanya sama sekali.
5. Penjelasan singkat satu baris, nonaktifkan satu baris kode sementara → pakai //
6. Nonaktifkan banyak baris sekaligus, tutup potongan kecil di tengah baris → pakai /* */
7. Jelaskan antarmuka kelas/metode, buat dokumen proyek otomatis → pakai ///

* Cara Membuat Dokumen

Bagian di bawah hanya sebagai referensi. Komentar dokumentasi umumnya dipakai pada proyek berskala besar, saat belajar cukup paham saja bahwa fitur ini ada.

Pengaturan di Visual Studio

1. Klik kanan proyek → Properti → tab Build (Bangun);
2. Centang opsi: Generate XML documentation file (Buat file dokumen XML);
3. Lokasi keluaran standar: bin\Debug\NamaProyek.xml, bisa ubah lokasi penyimpanan sendiri;
4. Centang untuk All Configurations (Semua Konfigurasi) agar mode Debug dan Release sama-sama menghasilkan file XML;
5. Bangun ulang proyek, file XML berisi semua komentar akan muncul di folder target.

Pengaturan Command Line .NET CLI (Tanpa Visual Studio)

Buka file .csproj milik proyek lalu tambahkan potongan tag berikut:

<PropertyGroup>
  <GenerateDocumentationFile>true</GenerateDocumentationFile>
</PropertyGroup>
Code language: HTML, XML (xml)

Jalankan perintah build:

dotnet build

Fungsi File XML

File XML ini menyimpan semua konten tag dokumentasi seperti <summary>、<param>、<returns>, menjadi sumber data untuk menghasilkan dokumen panduan. Selain itu Visual Studio akan membaca file ini dan menampilkan isi komentar di tooltip IntelliSense saat kursor melayang di atas kode.

Tools Lain untuk Buat Dokumentasi

DocFX buatan Microsoft (direkomendasikan resmi Microsoft, mudah dipakai buat situs dokumen HTML statis)

Sandcastle (tool lama Microsoft untuk membuat file bantuan offline format CHM)

Tool ringkas pihak ketiga (contohnya Doxygen)

Tiga jenis sintaks komentar sudah dijelaskan lengkap