Dalam artikel ini, kita akan belajar mengenai komen C #, gaya komen yang berbeza, dan mengapa dan bagaimana menggunakannya dalam program.
Komen digunakan dalam program untuk membantu kita memahami sekeping kod. Ia adalah kata-kata yang dapat dibaca manusia yang bertujuan menjadikan kod itu dapat dibaca. Komen tidak diendahkan sepenuhnya oleh penyusun.
Di C #, terdapat 3 jenis komen:
- Komen Baris Tunggal (
//) - Komen Pelbagai Garis (
/* */) - Komen XML (
///)
Komen Garis Tunggal
Komen baris tunggal bermula dengan garis miring berganda //. Penyusun mengabaikan segalanya setelah //akhir baris. Sebagai contoh,
int a = 5 + 7; // Menambah 5 dan 7
Inilah Adding 5 and 7komennya.
Contoh 1: Menggunakan komen baris tunggal
// 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 mengandungi 3 komen baris tunggal:
// Hello World Program // Pelaksanaan Bermula dari kaedah Utama
dan
// Mencetak Hello World
Komen baris tunggal boleh ditulis dalam baris yang berasingan atau bersama dengan kod dalam baris yang sama. Walau bagaimanapun, disarankan untuk menggunakan komen dalam baris yang berasingan.
Komen Pelbagai Garis
Komen berbilang baris bermula dengan /*dan berakhir dengan */. Komen berbilang baris boleh merangkumi beberapa baris.
Contoh 2: Menggunakan komen berbilang 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 mengandungi 2 komen berbilang baris:
/ * Ini adalah Program Hello World di C #. Program ini mencetak Hello World. * /
dan
/ * Cetakan Hello World * /
Di sini, kita mungkin menyedari bahawa tidak wajib bagi komen berbilang baris untuk merangkumi beberapa baris. /*… */boleh digunakan sebagai ganti komen satu baris.
Komen Dokumentasi XML
Komen dokumentasi XML adalah ciri khas dalam C #. Dimulai dengan garis miring tiga ///dan digunakan untuk menjelaskan secara kategorinya sepotong kod… Ini dilakukan dengan menggunakan tag XML dalam komen. Komen ini kemudian digunakan untuk membuat fail dokumentasi XML yang terpisah.
Sekiranya anda tidak biasa dengan XML, lihat Apa itu XML?
Contoh 3: Menggunakan komen dokumentasi XML
/// /// This is a hello world program. /// using System; namespace HelloWorld ( class Program ( public static void Main(string() args) ( Console.WriteLine("Hello World!"); ) ) )
Komen XML yang digunakan dalam program di atas adalah
/// /// Ini adalah program hello world. ///
Dokumentasi XML (fail .xml) yang dihasilkan akan mengandungi:
Hai dunia
Lawati Komen Dokumentasi XML jika anda berminat untuk mempelajari lebih lanjut.
Gunakan Komen dengan Cara yang Betul
Komen digunakan untuk menjelaskan bahagian kod tetapi tidak boleh digunakan secara berlebihan.
Sebagai contoh:
// Mencetak Hello World Console.WriteLine ("Hello World");
Tidak perlu menggunakan komen dalam contoh di atas. Jelas bahawa garis itu akan mencetak Hello World. Komen harus dielakkan dalam kes seperti itu.
- Sebaliknya komen harus digunakan dalam program untuk menjelaskan algoritma dan teknik yang kompleks.
- Komen harus pendek dan tepat, bukannya penerangan yang panjang.
- Sebagai kaedah praktik, lebih baik menjelaskan mengapa, bukan bagaimana caranya , menggunakan komen.
