我到处读到doxygen是为C#代码生成文档的方法。我有一个接口,我想首先记录它(早期步骤),它已经有了XML注释(/)。
由于有大量的帖子和信息(包括doxygen.org)说这些评论已经被支持,所以当我运行doxywizard时,我会发现“警告:复合公司::产品::MyInterface没有文档化”这样的错误。
这让我相信,我在某种程度上误解了XML文档(希望不是,根据MSDN,我说的是正确的东西),或者我错配置了doxywizard。
我首先通过Wizard选项卡运行doxywizard,并指定要支持C#/Java。当我运行它时,我的HTML页面是空的,大概是因为前面提到的警告.然后我尝试通过Expert选项卡指定一个文件,然后再次运行--相同的行为。
有人能告诉我我缺少什么开关或设置来获得生成HTML的doxygen吗?
下面是一个例子,说明文档化的属性/方法在我的界面中是什么样子的:
/// <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 {...}发布于 2011-08-31 13:47:14
我想我已经搞清楚了。doxygen手册指出,EXTRACT_ALL =0是默认设置,在本例中“只为文档成员、文件、类和名称空间生成文档”。现在,我以为我已经把它们正确地记录下来了,但显然不是。我刚刚启用了EXTRACT_ALL,警告就消失了,我得到了我的界面的文档!我阅读了“特殊文档块”,认为我遗漏了一些东西(感谢Eric的评论),但是它没有提到为C#代码做任何特别的事情,所以我假设EXTRACT_ALL的默认值应该仍然有效。
https://stackoverflow.com/questions/7257281
复制相似问题