다음을 통해 공유


<param>(C# 프로그래밍 가이드)

<param name="name">description</param>

매개 변수

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

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

설명

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

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

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

예제

// compile with: /doc:DocFileName.xml  

/// text for class TestClass 
public class TestClass
{
    // Single parameter. 
    /// <param name="Int1">Used to indicate status.</param>
    public static void DoWork(int Int1)
    {
    }

    // Multiple parameters. 
    /// <param name="Int1">Used to indicate status.</param>
    /// <param name="Float1">Used to specify context.</param>
    public static void DoWork(int Int1, float Float1)
    {
    }

    /// text for Main 
    static void Main()
    {
    }
}

참고 항목

참조

문서 주석에 대한 권장 태그(C# 프로그래밍 가이드)

개념

C# 프로그래밍 가이드