.Net 프로젝트 (Sandcastle)에 대한 네임 스페이스 문서?

.Net 프로젝트 (Sandcastle)에 대한 네임 스페이스 문서?

---

저는 얼마 전에 Sandcastle을 사용하여 프로젝트 중 하나에 대한 문서 웹 사이트를 생성 하기 시작했습니다 . 꽤 잘 작동하지만 우리는 항상 프로젝트의 클래스, 메서드, 속성 (...)에 대한 문서 만 작성했으며 전체 프로젝트 및 프로젝트 부분 / 모듈 / 네임 스페이스에 대해 완전히 별도의 문서를 작성했습니다. 해당 문서를 함께 병합하고 생성 된 도우미 파일에 각 문서를 추가 할 수 있다면 좋을 것 같지만 어떻게해야할지 모르겠습니다.

네임 스페이스 선언에 주석을 추가하는 것만으로는 작동하지 않는 것 같습니다 (C #).

/// <summary>
/// My short namespace description
/// </summary>
namespace MyNamespace { ... }

누구든지 이것을하는 방법을 알고 있습니까? 나는 그것이 어떻게 든 가능하다는 것을 알고 있으며 정말 좋을 것입니다 ... :)

---

Sandcastle은 또한 ndoc 스타일의 네임 스페이스 문서를 지원하므로 소스 파일에 문서를 고정 할 수 있습니다.

문서화하려는 네임 스페이스에 NamespaceDoc이라는 비공개 클래스를 생성하기 만하면 해당 클래스의 xml 문서 주석이 네임 스페이스에 사용됩니다.

문서에 클래스 자체가 표시되지 않도록 [CompilerGenerated] 속성으로 장식하십시오.

예:

namespace Some.Test
{
    /// <summary>
    /// The <see cref="Some.Test"/> namespace contains classes for ....
    /// </summary>

    [System.Runtime.CompilerServices.CompilerGenerated]
    class NamespaceDoc
    {
    }
}

SandCastle의 작업 항목은 여기 에 있습니다.

---

당신이 사용하는 경우 샌드캐슬 도움말 파일 빌더를 네임 스페이스 요약을 입력 할 수있는 대화 상자가있다. (분명히 특정 클래스 정의를 지원하지만 선호하지 않습니다.)

기능 목록에서 :

도움말 파일에 나타날 프로젝트 요약 및 네임 스페이스 요약 주석의 정의. 도움말 파일에 포함하거나 제외 할 네임 스페이스를 쉽게 나타낼 수도 있습니다. 각 네임 스페이스 내에서 NamespaceDoc 클래스를 통해 네임 스페이스 주석을 지정하기위한 지원도 포함됩니다.

---

Sandcastle Help File Builder를 사용하십시오 . XML 프로젝트 파일에 네임 스페이스 설명을 지정할 수 있습니다.

예:

<namespaceSummaryItem name="System" isDocumented="True">
    Generic interfaces and helper classes.
</namespaceSummaryItem>

참조 :

• 모든 빌드와 함께 문서를 생성하는 오픈 소스 프로젝트의 예 (모든 스크립트가 트렁크에 있음).
• 이것이 SHFB의 문서가 웹에서 보이는 방식입니다 (모든 강제 빌드에 배포 됨).

.

---

나는 그것이 오래된 게시물이라는 것을 알고 있지만 이것은 다른 사람에게 도움이 될 수 있습니다.

이 링크를 따라 가면 프로젝트에 비공개 클래스를 추가 할 필요없이 네임 스페이스에 대한 설명을 설정할 수 있습니다.

네임 스페이스 요약을 편집하려면 SHFB의 프로젝트 속성 탭에서 요약 섹션을 확장합니다. 처음에 "(None)"값을 표시하는 "NamespaceSummaries"라는 설정이 표시됩니다. 설정을 클릭하여 선택하면 줄임표 기호 (...)가 표시된 버튼이 나타납니다. 이 버튼을 클릭하면 아래 그림과 같은 네임 스페이스 요약 대화 상자가 표시됩니다.

---

그런 식으로 참조를 추가 할 수 없습니다. NamespaceDoc.cs 인스턴스를 통해 수행합니다.

즉

/// <summary> /// Concrete implementation of see cref="IInterface" using see cref="Concrete"
/// </summary> class NamespaceDoc { }

여길 봐

---

"외부 XML 주석 파일"에 대한 문서를 참조하십시오. 다음과 같은 스키마 표시 :

<doc>
    <assembly/>
    <members>
        <member/>
    </members>
</doc>

이것이 별도의 파일에 배치되는 경우 확장자는 (xml / aml)이며 Visual Studio 프로젝트에서 사용할 수 있습니까?

참고 URL : https://stackoverflow.com/questions/156582/namespace-documentation-on-a-net-project-sandcastle