2014-09-10 63 views
1

我正在使用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命令将该类组合到特定模块中。

回答

0

据我所知,没有这样的工具存在。 C#使用程序集和命名空间来对API进行概念分组。单独定义手动分组只会使熟悉该语言的用户感到困惑。

为了获得最佳效果,您应该使用C#文档注释以及Sandcastle Help File Buildermy fork of the project(它使用稍微不同的表示样式)的最新版本。这些工具更干净地集成到Visual Studio中,继续继续工作,如IntelliSense扩展和文档注释中的代码完成(Roslyn + SHFB非常好,但我仍然希望看到它进一步改进)。以下页面显示使用后者的相当新的文档构建:

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