Doxygen으로 처리하기 위해 package/namespace 레벨에 .NET 소스 문서를 추가하십시오.

Question

doxygen 및 XML 문서 주석을 사용하여 우리의 프레임 워크 라이브러리에 대한 내부 API 문서를 만듭니다.

Doxygen은 네임 스페이스 당 "패키지"를 만듭니다. 네임 스페이스 수준의 소스 문서를 추가하여 Doxygen의 패키지보기에 표시 할 수 있습니까?

Answer 1

표준 <summary> XML 주석 스타일을 사용하여이 작업을 수행 할 수 있습니다.

Visual Studio에서 네임 스페이스를 주석 처리 할 수 ​​있다는 사실을 인식하지 못하더라도 단일 네임 스페이스 선언 위에 요약 문서를 추가하면 해당 설명이 생성 된 문서에 추가됩니다. 예를 들어

는 :

using System; 
using System.Web; 
using System.Web.Caching; 

/// <summary> 
/// Testing namespace package descriptions 
/// </summary> 
namespace MyProject.Caching 
{ 
    ... 

당신은 각 네임 스페이스에 대해 의견을 XML의 인스턴스를 추가해야합니다. 예를 들어 동일한 네임 스페이스 아래에 모두 선언 된 두 개의 클래스와 인터페이스가있는 경우 Doxygen이 해당 네임 스페이스에 대한 설명을 추가하기 위해 한 번만 주석을 제공하면됩니다. 클래스 나 인터페이스에 이러한 주석을 추가 할 지 여부는 중요하지 않습니다.

충돌하는 이름 공간 설명이 추가되는 경우 Doxygen은 찾은 첫 번째 인스턴스 만 선택하고 다른 인스턴스는 무시합니다.