使用單獨的文件來擴展文檔

我正在使用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命令將該類組合到特定模塊中。

來源

2014-09-10 Daniel Tigges

據我所知，沒有這樣的工具存在。 C＃使用程序集和命名空間來對API進行概念分組。單獨定義手動分組只會使熟悉該語言的用戶感到困惑。

爲了獲得最佳效果，您應該使用C＃文檔註釋以及Sandcastle Help File Builder或my fork of the project（它使用稍微不同的表示樣式）的最新版本。這些工具更乾淨地集成到Visual Studio中，繼續繼續工作，如IntelliSense擴展和文檔註釋中的代碼完成（Roslyn + SHFB非常好，但我仍然希望看到它進一步改進）。以下頁面顯示使用後者的相當新的文檔構建：

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

來源

2014-09-19 12:44:19

使用單獨的文件來擴展文檔

回答

相關問題