Share via


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

업데이트: 2007년 11월

<list type="bullet" | "number" | "table">
    <listheader>
        <term>term</term>
        <description>description</description>
    </listheader>
    <item>
        <term>term</term>
        <description>description</description>
    </item>
</list>

매개 변수

  • term
    description에서 정의할 용어입니다.

  • description
    글머리 기호 목록이나 번호 매기기의 항목 또는 term의 정의입니다.

설명

<listheader> 블록은 테이블이나 정의 목록의 머리글 행을 정의하는 데 사용됩니다. 테이블을 정의할 때는 머리글의 term에 대한 엔트리만 제공하면 됩니다.

목록의 각 항목은 <item> 블록으로 지정합니다. 정의 목록을 만들 때는 term과 description을 모두 지정해야 합니다. 그러나 테이블, 글머리 기호 목록 또는 번호 매기기 목록의 경우에는 description에 대한 입력만 제공하면 됩니다.

목록이나 테이블에 사용할 수 있는 <item> 블록의 수에는 제한이 없습니다.

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

예제

// compile with: /doc:DocFileName.xml 

/// text for class TestClass
public class TestClass
{
    /// <summary>Here is an example of a bulleted list:
    /// <list type="bullet">
    /// <item>
    /// <description>Item 1.</description>
    /// </item>
    /// <item>
    /// <description>Item 2.</description>
    /// </item>
    /// </list>
    /// </summary>
    static void Main()
    {
    }
}

참고 항목

개념

C# 프로그래밍 가이드

참조

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