문서 주석에 대한 권장 XML 태그(Visual Basic)
Visual Basic 컴파일러는 코드의 설명서 주석을 XML 파일로 처리할 수 있습니다. 추가 도구를 사용하여 XML 파일을 설명서로 처리할 수 있습니다.
XML 주석은 형식 및 형식 멤버와 같은 코드 구문에서 허용됩니다. 부분 형식의 경우 멤버 주석 처리에 제한이 없지만 형식의 한 부분만 XML 주석을 사용할 수 있습니다.
참고
설명서 주석은 네임스페이스에 적용할 수 없습니다. 그 이유는 하나의 네임스페이스가 여러 어셈블리에 걸쳐 있을 수 있으며 모든 어셈블리를 동시에 로드할 필요는 없기 때문입니다.
컴파일러는 유효한 XML인 모든 태그를 처리합니다. 다음 태그는 사용자 설명서에서 일반적으로 사용되는 기능을 제공합니다.
- <C>
- <코드>
- <예제>
- <예외>1
- <포함>1
- <목록>
- <파라>
- <param>1
- <paramref>
- <권한>1
- <발언>
- <반환>
- <참조>1
- <seealso>1
- <요약>
- <typeparam>1
- <value>
(1 컴파일러는 구문을 확인합니다.)
참고
설명서 주석의 텍스트에 꺾쇠 괄호를 표시하려면 및 >
를 사용합니다<
. 예를 들어 문자열 "<text in angle brackets>"
은 로 <text in angle brackets>
표시됩니다.