네임 스페이스에 대한 XML 문서

Question

네임 스페이스에 대해 xml-doc을 작성 하시겠습니까? 그리고 그렇다면 어떻게 그리고 어디에서?

는 어쩌면,이 같은 거의 빈 파일 가능하다면 내가 생각 :

/// <summary> 
/// This namespace contains stuff 
/// </summary> 
namespace Some.Namespace 
{ 

} 

그러나 것을 사용할 수 있습니까? 당신이 ... 선언했거나 적어도 다른 모든 파일에서도 네임 스페이스를 사용합니다 ... 그리고 XML 네임 스페이스를 다른 네임 스페이스에 쓴다면 어떻게 될까요? 하나는 없어지겠습니까? 아니면 어떻게 든 병합 될까요?

Answer 1

NDoc 각 네임 스페이스에있는 특별한 NamespaceDoc 클래스를 인식하고, 그에서 문서를 사용하여이 작업을 지원합니다. 나는 그것을 시도하지 않았지만 Sandcastle은 같은 트릭을 지원하는 것으로 보인다.

편집 : 예를 들어 가 :

namespace Some.Namespace 
{ 
    /// <summary> 
    /// This namespace contains stuff 
    /// </summary> 
    public static class NamespaceDoc 
    { 
    } 
} 

Answer 2

네임 스페이스에 주석을 달 수 없습니다.

UseNamespaceDocSummaries on http://ndoc.sourceforge.net/content/documenters.htm

Answer 3

샌드캐슬 직접 NamespaceDoc을 지원하지 않지만, 당신이 사용하는 경우 Sandcastle Help File Builder 당신이 팀에 의해 언급 된 NamespaceDoc 클래스를 사용할 수 있습니다.

SCHB는 또한 구문을 약간 확장하고 코드 예제를 코드 파일에서 바로 임베드 할 수 있도록합니다. 예제 _Namespace.xml :

<?xml version="1.0" encoding="utf-8" ?> 
<Documentation> 
    <summary> 
    <h1 class="heading">Example Namespace</h1> 
    <para> 
     This namespace is used in the following way: 
    </para> 

    <code source="Examples\Class.cs" lang="cs"></code> 
    <code source="Examples\Class.vb" lang="vbnet"></code> 

    <para> 
     Hopefully this helps! 
    </para> 
    </summary> 
</Documentation> 

XML 파일의 문서를 포함하면 도움말 파일에 대한 별도의 XML 파일에 코드를 큰 설명에 짧은 요약을 작성할 수 있습니다. 이 방법은 코드가 모든 세부 사항으로 복잡하지 않고 쉽게 읽을 수 있습니다.

Answer 4

Mono의 mdoc 설명서 시스템을 사용하는 경우 ns - *. xml 설명서 파일을 편집하여 네임 스페이스 구성원을 문서화 할 수 있습니다.

자세한 내용은 mdoc file format documentation을 참조하십시오.

Answer 5

Sandcastle 도움말 파일 작성기는 네임 스페이스에 대한 설명을 지원합니다. Sandcastle 프로젝트를 엽니 다. Project Properties 창에서 Summaries으로 이동하고 Edit Namespace Summaries 버튼을 클릭하십시오.

Answer 6

당신은 사용 doxygen이 그것을 수행 할 수 있습니다

/// <summary> 
/// description 
/// </summary> 
namespace name{}; 

또한, 그것은 NameSpaces.cs 파일에 네임 스페이스를 선언 만이 파일에 주석하는 것이 좋습니다.