忽略Doxygen注释/属性

Question

我使用doxygen生成xml，然后将其转换为自定义文档。

doxygen是否有可能包含字段/类/函数的注释。

在java和c#中注释都被忽略。例如：

class User
{ 
    [Required]
    string UserName {get;set;}              
}

doxygen中没有解析/显示“必需的”注释。

我希望doxygen的xml / html输出中包含的是属性/字段/类的所有带注释的注释。“必填”)。

Answer 1

在这种情况下，EXTRACT_ALL=YES是无用的。看看这个答案，我认为这是个好主意：Doxygen and add a value of an attribute to the output documentation

因此，您必须创建过滤器(例如，在phyton中)，Doxygen将使用该过滤器将注释转换为注释。别忘了通知Don关于你的过滤器：INPUT_FILTER = doxygenFilter.py我也有同样的问题，所以我用这种方式修改了这个例子：

#!/usr/bin/env python
import sys
import re

if (len(sys.argv) < 2):
    print "No input file"
else:
    f = open(sys.argv[1])
    line = f.readline()
    while line:
        re1 = re.compile("\s*\[(.*)]\s*")
        re1.search(line)
        sys.stdout.write(re1.sub(r"/// <para>Annotation: [\1]</para>\n", line))
        #sys.stdout.write(line)
        line = f.readline()
    f.close()

所以代码就像

[AnyAnnotation()]

将转换为：

/// <param> Annotation [AnyAnnotation()] </param>`

所以我得到了非常好的结果。标签<param>是为了避免avoid将这个注释描述放到主描述中。相反，它将把它放在备注部分。

Answer 2

我不知道你在问什么，但我会说一些可能对你有帮助的事情。

必须对Doxygen进行配置，以便为没有Doxygen注释的代码元素生成文档。换句话说，您可以告诉Doxygen为所有函数、变量、宏等生成文档，即使它们没有记录在代码中。在配置文件中设置EXTRACT_ALL=YES。

如果您运行DoxyWizard，您将对所有可用选项以及每个选项的效果有更好的了解。DoxyWizard是Doxygen的图形用户界面前端。

顺便说一句，记录你的代码太棒了！