使用单独的文件来扩展文档答案

【问题标题】：Use separate file to extend documentation使用单独的文件来扩展文档
【发布时间】：2014-11-04 03:25:33
【问题描述】：

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

【问题讨论】：

标签： c# doxygen

【解决方案1】：

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

为获得最佳结果，您应该使用 C# 文档 cmets 以及最新版本的 Sandcastle Help File Builder 或 my fork of the project（使用略有不同的演示风格）。这些工具更干净地集成到 Visual Studio 中，并且继续开发诸如 IntelliSense 扩展和文档 cmets 中的代码完成等功能（Roslyn+SHFB 非常好，但我仍然希望看到它进一步改进）。以下页面显示了使用后者构建的相当新的文档：

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

【讨论】：