Pada artikel ini, kita akan belajar tentang komentar C #, gaya komentar yang berbeda, dan mengapa dan bagaimana menggunakannya dalam sebuah program.
Komentar digunakan dalam program untuk membantu kami memahami sepotong kode. Itu adalah kata-kata yang dapat dibaca manusia yang dimaksudkan untuk membuat kode tersebut dapat dibaca. Komentar sepenuhnya diabaikan oleh kompilator.
Di C #, ada 3 jenis komentar:
- Komentar Baris Tunggal (
//) - Komentar Multi Baris (
/* */) - Komentar XML (
///)
Komentar Baris Tunggal
Komentar baris tunggal dimulai dengan garis miring ganda //. Kompilator mengabaikan semuanya setelah //akhir baris. Sebagai contoh,
int a = 5 + 7; // Menambahkan 5 dan 7
Ini, Adding 5 and 7komentarnya.
Contoh 1: Menggunakan komentar satu baris
// Hello World Program using System; namespace HelloWorld ( class Program ( public static void Main(string() args) // Execution Starts from Main method ( // Prints Hello World Console.WriteLine("Hello World!"); ) ) )
Program di atas berisi 3 baris komentar:
// Program Hello World // Eksekusi Dimulai dari metode Utama
dan
// Mencetak Hello World
Komentar baris tunggal dapat ditulis dalam baris terpisah atau bersama dengan kode di baris yang sama. Namun, disarankan untuk menggunakan komentar di baris terpisah.
Komentar Multi Baris
Komentar multi baris dimulai dengan /*dan diakhiri dengan */. Komentar multi baris dapat mencakup beberapa baris.
Contoh 2: Menggunakan komentar multi baris
/* This is a Hello World Program in C#. This program prints Hello World. */ using System; namespace HelloWorld ( class Program ( public static void Main(string() args) ( /* Prints Hello World */ Console.WriteLine("Hello World!"); ) ) )
Program di atas berisi 2 komentar multi baris:
/ * Ini adalah Program Hello World di C #. Program ini mencetak Hello World. * /
dan
/ * Mencetak Hello World * /
Di sini, kami mungkin telah memperhatikan bahwa komentar multi baris tidak wajib mencakup beberapa baris. /*… */dapat digunakan sebagai pengganti komentar baris tunggal.
Komentar Dokumentasi XML
Komentar dokumentasi XML adalah fitur khusus di C #. Ini dimulai dengan garis miring tiga ///dan digunakan untuk mendeskripsikan sepotong kode secara kategoris … Ini dilakukan dengan menggunakan tag XML dalam komentar. Komentar ini kemudian digunakan untuk membuat file dokumentasi XML yang terpisah.
Jika Anda tidak terbiasa dengan XML, lihat Apa itu XML?
Contoh 3: Menggunakan komentar dokumentasi XML
/// /// This is a hello world program. /// using System; namespace HelloWorld ( class Program ( public static void Main(string() args) ( Console.WriteLine("Hello World!"); ) ) )
Komentar XML yang digunakan dalam program di atas adalah
/// /// Ini adalah program hello world. ///
Dokumentasi XML (file .xml) yang dihasilkan akan berisi:
Halo Dunia
Kunjungi Komentar Dokumentasi XML jika Anda tertarik untuk mempelajari lebih lanjut.
Gunakan Komentar dengan Cara yang Benar
Komentar digunakan untuk menjelaskan bagian-bagian kode tetapi tidak boleh digunakan secara berlebihan.
Sebagai contoh:
// Mencetak Hello World Console.WriteLine ("Hello World");
Menggunakan komentar pada contoh di atas tidak perlu. Jelas bahwa baris tersebut akan mencetak Hello World. Komentar harus dihindari dalam kasus seperti itu.
- Sebaliknya komentar harus digunakan dalam program untuk menjelaskan algoritma dan teknik yang kompleks.
- Komentar harus pendek dan langsung pada intinya, bukan deskripsi panjang.
- Sebagai aturan praktis, lebih baik menjelaskan mengapa daripada bagaimana , menggunakan komentar.
