코드를 XML로 문서화(Visual Basic)

  • 아티클

Visual Basic에서는 XML을 사용하여 코드를 문서화할 수 있습니다.

XML 문서 주석

Visual Basic은 프로젝트에 대한 XML 문서를 자동으로 만드는 간편한 방법을 제공합니다. 형식 및 멤버에 대한 XML 구조를 자동으로 생성한 다음 각 매개 변수에 대한 요약, 설명 문서, 기타 설명을 제공할 수 있습니다. 적절한 설정을 사용하면 XML 문서가 프로젝트와 동일한 루트 파일 이름이 있는 XML 파일로 자동으로 내보내집니다. XML 문서 파일 생성의 구성에 대한 자세한 내용은 -doc 컴파일러 옵션 및 GenerateDocumentationFile MSBuild 속성을 참조하세요.

XML 파일은 XML로 사용되거나 다른 방식으로 조작될 수 있습니다. 이 파일은 프로젝트의 출력 .exe 또는 .dll 파일과 동일한 디렉터리에 있습니다.

XML 문서는 '''로 시작합니다. 이러한 주석의 처리에는 몇 가지 제한이 있습니다.

  • 문서는 잘 구성된 XML이어야 합니다. XML의 형식이 올바르지 않으면 경고가 생성되고 문서 파일에 오류가 발생했다는 주석이 포함됩니다.

  • 개발자는 각자 고유한 태그 집합을 만들 수 있습니다. 권장되는 태그 집합이 있습니다(XML 주석 태그 참조). 권장 태그 중 일부는 특별한 의미가 있습니다.

    • <param> 태그는 매개 변수를 설명하는 데 사용됩니다. 사용되는 경우 컴파일러는 매개 변수가 있고 모든 매개 변수가 문서에서 설명되었는지 확인합니다. 확인에 실패하면 컴파일러가 경고를 실행합니다.

    • cref 특성을 태그에 연결하여 코드 요소에 대한 참조를 제공할 수 있습니다. 컴파일러에서 이 코드 요소가 있는지 확인합니다. 확인에 실패하면 컴파일러가 경고를 실행합니다. 또한 컴파일러는 cref 속성에 설명된 형식을 찾을 때 모든 Imports 문을 준수합니다.

    • <summary> 태그는 Visual Studio의 IntelliSense에서 형식이나 멤버에 대한 추가 정보를 표시하는 데 사용됩니다.

문서 주석이 있는 XML 파일을 만드는 방법에 대한 자세한 내용은 다음 항목을 참조하세요.

참고 항목