C# Komentar

C# Komentar

Dalam artikel ini, kita akan mempelajari tentang komentar C#, gaya komentar yang berbeda, dan mengapa serta bagaimana menggunakannya dalam sebuah program.

Komentar digunakan dalam sebuah program untuk membantu kita memahami sepotong kode. Mereka adalah kata-kata yang dapat dibaca manusia yang dimaksudkan untuk membuat kode dapat dibaca. Komentar sepenuhnya diabaikan oleh kompilator.

Di C#, ada 3 jenis komentar:

1. Komentar Satu Baris ( // )
2. Komentar Multi Baris (/* */ )
3. Komentar XML ( /// )

---

Komentar Satu Baris

Komentar satu baris dimulai dengan garis miring ganda // . Kompiler mengabaikan semuanya setelah // ke akhir baris. Misalnya,

int a = 5 + 7; // Adding 5 and 7

Di sini, Adding 5 and 7 adalah komentarnya.

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 komentar satu baris:

// Hello World Program
// Execution Starts from Main method

dan

// Prints Hello World

Komentar baris tunggal dapat ditulis dalam baris terpisah atau bersama dengan kode dalam baris yang sama. Namun, disarankan untuk menggunakan komentar di baris terpisah.

---

Komentar Banyak Baris

Komentar multi baris dimulai dengan /* dan diakhiri dengan */ . Komentar multi-baris dapat menjangkau 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:

/*
This is a Hello World Program in C#.
This program prints Hello World.
*/

dan

/* Prints Hello World */

Di sini, kita mungkin telah memperhatikan bahwa komentar multi-baris tidak diwajibkan untuk mencakup beberapa baris. /* … */ dapat digunakan sebagai pengganti komentar satu baris.

---

Komentar Dokumentasi XML

Komentar dokumentasi XML adalah fitur khusus dalam C#. Dimulai dengan garis miring tiga /// dan digunakan untuk mendeskripsikan sepotong kode secara kategoris.. Hal ini dilakukan dengan menggunakan tag XML dalam komentar. Komentar ini kemudian, digunakan untuk membuat file dokumentasi XML terpisah.

Jika Anda tidak terbiasa dengan XML, lihat Apa itu XML?

Contoh 3:Menggunakan komentar dokumentasi XML

/// <summary>
///  This is a hello world program.
/// </summary>

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

/// <summary>
/// This is a hello world program.
/// </summary>

Dokumentasi XML (file .xml) yang dihasilkan akan berisi:

<?xml version="1.0"?>
<doc>
	<assembly>
		<name>HelloWorld</name>
	</assembly>
	<members>
	</members>
</doc>

Kunjungi Komentar Dokumentasi XML jika Anda tertarik untuk mempelajari lebih lanjut.

---

Gunakan Komentar dengan Cara yang Benar

Komentar digunakan untuk menjelaskan bagian dari kode tetapi tidak boleh digunakan secara berlebihan.

Misalnya:

// Prints Hello World
Console.WriteLine("Hello World");

Menggunakan komentar dalam contoh di atas tidak perlu. Jelas bahwa garis tersebut akan mencetak Hello World. Komentar harus dihindari dalam kasus seperti itu.

• Sebaliknya, komentar harus digunakan dalam program untuk menjelaskan algoritme dan teknik yang kompleks.
• Komentar harus singkat dan to the point, bukan deskripsi yang panjang.
• Sebagai patokan, sebaiknya jelaskan mengapa alih-alih bagaimana , menggunakan komentar.