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

Question

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

Doxygen为每个命名空间创建一个"包".我想知道是否有可能在命名空间级别添加源文档以显示在Doxygen的包视图中？

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注释实例.例如,如果您有两个类和一个接口都在同一名称空间下声明,则只需要为Doxygen提供一次注释,以便为该名称空间添加描述.是否在任何类或接口上添加这些注释都是无关紧要的.

在添加了冲突的命名空间描述的地方,Doxygen将仅获取它找到的第一个实例并忽略任何其他实例.