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的概念分组。单独定义手动分组只会使熟悉该语言的用户感到困惑。

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

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

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

1 个答案: