패키지의 IntelliSense 및 트리플 슬래시 설명

Question

필자는 철저히 문서화하는 데 시간을 들인 코드 라이브러리를 개발했습니다.

클래스, 메소드 및 속성은 트리플 슬래시 XML (xmldoc) 주석을 사용하는 주석입니다. 나는 DLL 파일에이 컴파일 및 내 다른 프로젝트에서 참조, 또는 내가 언급도 NuGet 패키지로 포장 할 때

/// <summary> 
/// Adds two numbers together. 
/// </summary> 
/// <param name="a">The first number.</param> 
/// <param name="b">The second number.</param> 
/// <returns>The sum.</returns> 
public int Add(int a, int b) 
{ 
    return a + b; 
} 

, 그때 비주얼 스튜디오/인텔리 내 라이브러리의 모든 문서를 제공하지 않습니다.

왜 이런가요, 어떻게해야합니까?

Answer 1

문제를 해결할 수 있지만 xml doc 파일을 생성 해본 적이 있다면 100 % 확실하지 않습니다. 이 패키지가 dll과 함께 제공되는 경우 intelliSense에서 가져올 수 있습니다. 직접 인텔리 모든 문서를 제공 할 수는 없다 자사 .DLL하여 어셈블리를 참조 할 때

Answer 2

는 컴파일러 따라서, 생성 된 코멘트 모든 코멘트를 스트립.

프로젝트 속성에서 "XML 문서 파일"을 출력 할 수있게 설정하면 컴파일러에서 컴파일 된 .dll 파일 외에도 .xml 파일을 출력합니다. NuGet을 사용하여 패키지를 생성 할 때 (dotnet pack -c release 사용) XML 문서 파일이 포함되어 있으므로 NuGet을 사용하여 설치된 패키지는 IntelliSense에 설명서를 제공합니다 (있는 경우).