2010-02-03 7 views
8

다른 프로젝트의 dll을 참조하는 사람들이 속성 및 메서드 설명을 볼 수 있도록 클래스를 작성하려면 어떻게해야합니까? C# dll을 문서화하는 방법

[Description("My age in years attribute")] 
    public int Age 
    { 
     get { return 0; } 
     set { } 
    } 

는 작동하지 아니하며

/// <summary> 
    /// My age in years attribute 
    /// </summary> 
    public int Age 
    { 
     get { return 0; } 
     set { } 
    } 
+0

두 번째 *는 * 나를 위해 작동합니다. –

+0

어쩌면 내가 뭔가를 놓친거야,하지만 XML 주석 나를 위해 작동합니다. –

+0

두 번째 예제는 클래스를 참조하는 프로젝트가 동일한 솔루션 내에있는 경우 작동합니다. 나는 dll로 클래스를 컴파일하고이 DLL을 참조하고있다. DLL은 특성 또는 요약 정보를 보존하지 않는 것 같습니다. – James

답변

14

:

프로젝트 -> 속성 -> 빌드 -> "XML 문서 파일"을 확인하십시오.

자세한 내용은 XML Comments Let You Build Documentation Directly From Your Visual Studio .NET Source Files을 참조하십시오.

+0

그렇다면 XML을 DLL과 함께 배포하고 둘 다 참조해야한다는 의미입니까? DLL의 모든 정보를 가질 수있는 방법이 있습니까? – James

+0

아니요, XML 메모는 어셈블리의 메타 데이터 일부가 아닙니다. – jason

+0

이들을 메타 데이터의 일부로 만들려면 어떻게해야합니까? – James

1

DescriptionAttribute에서 제공되는 설명을 확실히 속성 표에서 볼 않는 그것은 코드 편집기와 아무 상관이 없습니다.

XML 주석을 사용하려면 generate an XML documentation file해야하며 어셈블리와 함께 제공해야합니다. Visual Studio에서

1

두 번째 경우에 XML documentation file을 만들었습니까?

프로젝트 속성 -> [출력] XML 문서 파일

1
두 번째 일을해야

(요약), 프로젝트 속성에서 선택해야합니다 (빌드 - -> 출력) XML 문서 파일 빌드> .

관련 문제