C# 주석

C# 댓글

이 기사에서는 C# 주석, 다양한 주석 스타일, 프로그램에서 주석을 사용하는 이유와 방법에 대해 알아봅니다.

주석은 코드를 이해하는 데 도움이 되도록 프로그램에서 사용됩니다. 코드를 읽을 수 있도록 의도된 사람이 읽을 수 있는 단어입니다. 주석은 컴파일러에서 완전히 무시됩니다.

C#에는 3가지 유형의 주석이 있습니다.

1. 한 줄 주석( // )
2. 여러 줄 주석(/* */) )
3. XML 주석( /// )

<시간>

한 줄 주석

한 줄 주석은 이중 슬래시 //으로 시작합니다. . 컴파일러는 // 이후의 모든 것을 무시합니다. 줄 끝까지. 예를 들어,

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

여기 Adding 5 and 7 댓글입니다.

예시 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

한 줄 주석은 별도의 줄에 작성하거나 같은 줄의 코드와 함께 작성할 수 있습니다. 단, 주석은 별도의 줄에 사용하는 것이 좋습니다.

<시간>

여러 줄 주석

여러 줄 주석은 /*로 시작합니다. */로 끝남 . 여러 줄 주석은 여러 줄에 걸쳐 있을 수 있습니다.

예시 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를 인쇄할 것이 분명합니다. 이러한 경우에는 댓글을 피해야 합니다.

• 복잡한 알고리즘과 기술을 설명하기 위해 프로그램에서 주석을 대신 사용해야 합니다.
• 댓글은 긴 설명 대신 짧고 요점을 알려야 합니다.
• 일반적으로 이유를 설명하는 것이 좋습니다. 방법 대신 , 댓글 사용