C# コメント

C# コメント

この記事では、C# コメント、さまざまなスタイルのコメント、プログラムでそれらを使用する理由と方法について学習します。

コメントは、コードの一部を理解するのに役立つようにプログラムで使用されます。これらは、コードを読みやすくすることを目的とした、人間が読める単語です。コメントはコンパイラによって完全に無視されます。

C# には、3 種類のコメントがあります:

<オール>

一行コメント ( // )

複数行のコメント (/* */ )

XML コメント ( /// )

---

一行コメント

単一行コメントは二重スラッシュ // で始まります .コンパイラは // 以降をすべて無視します 行の終わりまで。たとえば、

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

ここでは、Adding 5 and 7 はコメントです。

例 1:1 行コメントの使用

// 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!");
		}
	}
}

上記のプログラムには、3 つの単一行コメントが含まれています:

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

そして

// Prints Hello World

1 行のコメントは、別の行に記述したり、同じ行のコードと一緒に記述したりできます。ただし、コメントは別の行で使用することをお勧めします。

---

複数行のコメント

/* で始まる複数行のコメント */ で終わる .複数行のコメントは、複数行にまたがることができます。

例 2:複数行コメントの使用

/*
	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!");
		}
	}
}

上記のプログラムには、2 つの複数行のコメントが含まれています:

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

そして

/* Prints Hello World */

ここで、複数行のコメントが複数行にまたがることは必須ではないことに気付いたかもしれません。 /* … */ 単一行コメントの代わりに使用できます。

---

XML ドキュメント コメント

XML ドキュメント コメントは、C# の特別な機能です。トリプル スラッシュ /// で始まります これは、コメント内の XML タグを使用して行われます。これらのコメントは、別の XML ドキュメント ファイルを作成するために使用されます。

XML に慣れていない場合は、「XML とは?」を参照してください。

例 3: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!");
		}
	}
}

上記のプログラムで使用されている XML コメントは

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

生成される XML ドキュメント (.xml ファイル) には、以下が含まれます:

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

詳細に興味がある場合は、XML ドキュメントのコメントにアクセスしてください。

---

コメントを正しく使う

コメントはコードの一部を説明するために使用されますが、使いすぎないようにしてください。

例:

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

上記の例でコメントを使用する必要はありません。行が Hello World を出力することは明らかです。そのような場合、コメントは避けるべきです。

• 代わりに、プログラム内でコメントを使用して、複雑なアルゴリズムとテクニックを説明する必要があります。
• コメントは、長い説明ではなく、短く要点を示す必要があります。
• 経験則として、理由を説明することをお勧めします 方法の代わりに 、コメントを使用。