c# - 使用 doxygen 为带有 XML 注释的现有 C# 代码创建文档

Question

我到处都读到doxygen 是为 C# 代码生成文档的方法。我有一个我想首先记录的界面（小步骤），并且它已经存在 XML 注释 (///)。

由于大量帖子和可用信息（包括 doxygen.org）说这些评论已经得到支持，我很惊讶当我运行 doxywizard 时，我收到类似“警告：Compound Company::Product::MyInterface is没有记录”。

这使我相信我以某种方式误解了 XML 文档（希望不是，根据MSDN，我说的是正确的事情），或者我错误地配置了 doxywizard。

我首先通过 Wizard 选项卡运行 doxywizard，并指定我要支持 C#/Java。当我运行它时，我的 HTML 页面是空白的，大概是因为前面提到的警告。然后我尝试通过专家选项卡指定一个文件并再次运行——同样的行为。

谁能告诉我我缺少什么开关或设置来让 doxygen 生成 HTML？

这是我的界面中记录的属性/方法的示例：

/// <summary>
/// Retrieve the version of the device
/// </summary>
String Version { get; }

/// <summary>
/// Does something cool or really cool
/// </summary>
/// <param name="thing">0 = something cool, 1 = something really cool</param>
void DoSomething( Int32 thing);

我确实在界面上方有一条评论，如下所示：

/// <summary>
/// MyInterface
/// </summary>
public interface MyInterface {...}

Answer 1

我想我已经想通了。doxygen 手册说 EXTRACT_ALL = 0 是默认设置，在这种情况下“只会为记录的成员、文件、类和命名空间生成文档”。现在，我认为我已经正确地记录了它们，但显然不是。我刚刚启用了 EXTRACT_ALL，警告消失了，我得到了我的界面的文档！我阅读了“特殊文档块”，认为我遗漏了一些东西（感谢 Eric Farr 的评论），但它没有提到为 C# 代码做任何特殊的事情，所以我假设 EXTRACT_ALL 的默认值应该仍然有效。