Question

我已经读过无处不在的，doxygen是为C＃代码生成文档的方法。我有一个我想要首先记录的界面（婴儿步骤），它已经有XML注释（///）。

由于有大量的帖子和信息（包括doxygen.org）表示这些评论已经得到支持，我很惊讶当我运行doxywizard时，我收到的错误如“警告：复合公司::产品：：MyInterface没有记录“。

这让我相信我在某种程度上误解了XML文档（希望不是，根据MSDN我说的是正确的事情），或者我错误配置了doxywizard。

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

任何人都可以告诉我，为了生成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的默认值应该是仍然有效。

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

1 个答案: