.net - 在包/命名空间级别添加 .NET 源文档以使用 Doxygen 进行处理

Question

我使用 doxygen 和 XML 文档注释为我们的框架库创建内部 API 文档。

Doxygen 为每个命名空间创建一个“包”。我想知道是否可以在命名空间级别添加源文档以显示在 Doxygen 的包 View 中？

Answer 1

使用标准 <summary> 可以做到这一点。 XML 注释样式。

即使 Visual Studio 无法识别命名空间可以被注释这一事实，在任何单个命名空间声明之上添加摘要文档也会将该描述添加到您生成的文档中。

例如:

using System;
using System.Web;
using System.Web.Caching;

/// <summary> 
/// Testing namespace package descriptions
/// </summary>
namespace MyProject.Caching
{
   ...

您只需为每个命名空间添加一个 XML 注释实例。例如，如果您有两个类和一个接口(interface)，它们都在同一个命名空间下声明，您只需提供一次注释，Doxygen 就可以为该命名空间添加描述。无论您是在您的任何一个类上还是为界面添加这些注释，都无关紧要。

如果添加了冲突的命名空间描述，Doxygen 将只选择它找到的第一个实例并忽略任何其他实例。