문서 주석에 대한 권장 XML 태그(Visual Basic)Recommended XML Tags for Documentation Comments (Visual Basic)

Visual Basic 컴파일러는 코드의 문서 주석을 XML 파일로 처리할 수 있습니다.The Visual Basic compiler can process documentation comments in your code to an XML file. 추가 도구를 사용 하 여 XML 파일을 문서로 처리할 수 있습니다.You can use additional tools to process the XML file into documentation.

형식 및 형식 멤버와 같은 코드 구문에서 XML 주석을 사용할 수 있습니다.XML comments are allowed on code constructs such as types and type members. 부분 형식의 경우 해당 멤버를 주석으로 처리 하는 데 제한이 없더라도 형식의 한 부분 에서만 XML 주석을 사용할 수 있습니다.For partial types, only one part of the type can have XML comments, although there is no restriction on commenting its members.

참고

네임 스페이스에는 문서 주석을 적용할 수 없습니다.Documentation comments cannot be applied to namespaces. 그 이유는 한 네임 스페이스가 여러 어셈블리에 걸쳐 있을 수 있고 모든 어셈블리를 동시에 로드 해야 하는 것이 아니라는 것입니다.The reason is that one namespace can span several assemblies, and not all assemblies have to be loaded at the same time.

컴파일러는 유효한 XML 인 모든 태그를 처리 합니다.The compiler processes any tag that is valid XML. 다음 태그는 사용자 설명서에서 일반적으로 사용 되는 기능을 제공 합니다.The following tags provide commonly used functionality in user documentation.

<c> <code> <example>
<exception>1<exception> 1 <include>1<include> 1 <list>
<para> <param>1<param> 1 <paramref>
<permission>1<permission> 1 <remarks> <returns>
<see>1<see> 1 <seealso>1<seealso> 1 <summary>
<typeparam>1<typeparam> 1 <value>

(1 컴파일러는 구문을 확인 합니다.)(1 The compiler verifies syntax.)

참고

문서 주석 텍스트에 꺾쇠 괄호가 표시 되도록 하려면 및를 사용 &lt; &gt; 합니다.If you want angle brackets to appear in the text of a documentation comment, use &lt; and &gt;. 예를 들어 문자열은 "&lt;text in angle brackets&gt;" 로 표시 됩니다 <text in angle brackets> .For example, the string "&lt;text in angle brackets&gt;" will appear as <text in angle brackets>.

참조See also