C# xml 설명서

Question

.xml 어셈블리 파일과 함께 제공되는 설명서 파일 (.dll 파일)의 용도는 무엇입니까?

나는 하나 (as here, for example)를 만드는 방법을 알고 있지만 어떻게 사용할 수 있습니까?

또한이 설명서를 MS Visual Studio 환경에 통합 할 수 있다면 어떻게해야합니까?

Answer 1

XML 파일을 DLL과 동일한 폴더에 저장하면 Visual Studio에서 IntelliSense에 설명을 표시합니다. (매개 변수 툴팁 포함)

Answer 2

권장 태그가있는 xml 문서를 사용하면 외부 클래스에서 코드를 사용할 때 코드의 가독성이 크게 향상됩니다.

또한 Sandcastle과 같은 도구를 사용하여 xml 주석에서 도움말 문서를 생성 할 수 있습니다. 이 도구는 msdn for .NET 클래스에서 볼 수있는 문서와 매우 유사한 chm 파일을 생성합니다.

Visual Studio 환경으로의 통합은 자동으로 수행되며 프로젝트를 빌드하자마자 발생합니다. 문서화 된 클래스/메소드/속성을 사용하는 동안 Intellisense 기능은 XML 주석을 표시합니다.

또한 Ghost Doc (SubMain)과 같은 무료 Visual Studio 도구를 사용하면 키 보드 바로 가기를 사용하여 대부분의 태그를 생성 할 수 있습니다!