使用单独的文件扩展文档

本文关键字：扩展 文档 文件 单独 | 更新日期: 2023-09-27 18:21:26

我正在使用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），该文件将链接到该类并扩展现有文档？例如，使用''inggroup命令将类分组到特定模块中。

使用单独的文件扩展文档

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

为了获得最佳效果，您应该使用C#文档注释以及最新版本的Sandcastle Help File Builder或我的项目分支（使用稍微不同的表示风格）。这些工具更干净地集成到了Visual Studio中，并且还在继续开发IntelliSense扩展和文档注释中的代码完成等功能（Roslyn+SHFB非常好，但我仍然希望看到它得到进一步改进）。以下页面显示了使用后者构建的一个相当新的文档：

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

相关文章：