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

Question

我到处都读过，doxygen 是为 C# 代码生成文档的方法。我有一个我想首先记录的接口(interface)(婴儿步骤)，它已经有 XML 注释 (///)。

由于大量可用的帖子和信息(包括 doxygen.org)表明这些评论已得到支持，令我惊讶的是，当我运行 doxywizard 时，我收到类似“警告:Compound Company::Product: :MyInterface 没有记录。

这让我相信我以某种方式误解了 XML 文档(希望没有，根据 MSDN 我说的是对的)，或者我错误配置了 doxywizard。

我首先通过“向导”选项卡运行 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，警告消失了，我得到了我的界面的文档!我阅读了“特殊文档 block ”，认为我遗漏了一些东西(感谢 Eric Farr 的评论)，但它没有提到为 C# 代码做任何特殊的事情，所以我假设 EXTRACT_ALL 的默认值应该仍然有效。