Doxygen注释/属性被忽略

Question

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

doxygen是否可能包含字段/类/功能的注释。

在Java和C＃中，注释都将被忽略。 例如：

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

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

我希望在doxygen的xml / html输出中具有的是属性/字段/类的所有带注释的注释（例如，在“ [Required]”中）。

Answer 1

在这种情况下， EXTRACT_ALL=YES是没有用的。 看看这个答案，我认为这是个好主意： Doxygen并将属性值添加到输出文档中

因此，您必须创建过滤器（例如在phyton中），Doxygen将使用该过滤器将注释转换为注释。 不要忘了告诉Doxygen您的过滤器： 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>是为了避免Doxygen将此注释描述放在主要描述中。 而是将其放在备注部分。

Answer 2

我不确定您要问的是什么，但我会说一些可能对您有所帮助的事情。

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

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

顺便说一下，很赞！