java - 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 and add a value of an attribute to the output documentation

因此，您必须创建过滤器(例如在 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 将此注释描述放在主要描述中。相反，它会将其放在备注部分。