별도의 파일을 사용하여 문서를 확장하십시오.

Question

Doxygen을 사용하여 C#으로 작성된 거대한 프로젝트를 문서화하고 있습니다. 이 프로젝트의 기존 문서는 변경해서는 안됩니다.

기존 문서를 확장하고 특정 클래스 또는 메소드에 대해 doxygen 명령을 별도의 파일로 제공하는 방법이 있습니까?

예를 들어, 다음과 같이 설명되어 클래스 ViewModel.cs,이 말할 수 :

/// <summary> 
/// Defines a ViewModel that can be bound to a TreeList control. 
/// </summary> 
public abstract class ViewModel : IViewModel 
{ 
    /// <summary> 
    /// Gets the root elements to be displayed in the TreeList. 
    /// </summary> 
    public ObservableCollection<ITreeNode> Elements { get; protected set; } 
} 

별도의 파일을 생성 할 수있는 방법이 있나요 (.dox) 클래스에 링크 될 것이다 기존 문서를 확장합니까? 예 : \ ingroup 명령을 사용하여 클래스를 특정 모듈로 그룹화합니다.

Answer 1

내 지식으로는 그러한 도구가 없습니다. C#은 API의 개념적 그룹화를 위해 어셈블리와 네임 스페이스를 사용합니다. 별도로 수동 그룹화를 정의하면 언어에 익숙한 사용자를 혼동시키는 역할을합니다.

최상의 결과를 얻으려면 최신 릴리스 Sandcastle Help File Builder 또는 my fork of the project (약간 다른 프레젠테이션 스타일 사용)과 함께 C# 설명서 주석을 사용해야합니다. 이러한 도구는 Visual Studio에보다 깔끔하게 통합되어 있으며 문서 주석 내에서 IntelliSense 확장 및 코드 완성과 같은 기능을 계속 사용합니다 (Roslyn + SHFB는 상당히 훌륭하지만 계속 개선하기를 원합니다). 다음 페이지는 후자를 사용하여 상당히 최근의 문서 빌드를 보여줍니다.

http://openstacknetsdk.org/docs-master/