[개발] C# 프로그래머 참조 - 문서 주석에 대한 권장 태그 <param>

C# 프로그래머 참조

<param>

<param name='name'>description</param>

다음은 각 문자에 대한 설명입니다.

name

메서드 매개 변수의 이름입니다. name은 작은따옴표(' ')로 묶습니다.

description

매개 변수에 대한 설명입니다.

설명

메서드의 매개 변수 중 하나를 설명하려면 메서드 선언의 주석에서 <param> 태그를 사용해야 합니다.

<param> 태그의 텍스트는 IntelliSense, 개체 브라우저 및 코드 주석 웹 보고서에 표시됩니다.

/doc로 컴파일하여 문서 주석을 파일로 저장합니다.

예제

// xml_param_tag.cs
// compile with: /doc:xml_param_tag.xml 

/// text for class MyClass
public class MyClass 
{
   /// <param name="Int1">Used to indicate status.</param>
   public static void MyMethod(int Int1) 
   {
   }
   /// text for Main
   public static void Main () 
   {
   }
}

참고 항목

문서 주석에 대한 권장 태그