我工作的公司不使用Doxygen,并且在他们的编码标准中明确禁止"诸如javadoc等可解析注释样式";。
然而,我仍然发现自己运行Doxygen非常有用,这样我就可以看到类的结构,并获得一个类所拥有的所有方法的良好的类文档,包括继承的方法。
该公司确实在头文件中记录了类,在每个方法声明上方都有简单的注释。如果我可以配置Doxygen将这些注释视为功能描述,即使它们没有以任何Doxygen标记开头,这将非常有用。
那么:是否可以让Doxygen将上述声明行上的注释视为该项的描述,即使注释没有标记Doxygen的";解析这个评论";标记?
下一个最好的方法是单击类文件顶部的#include <foo.h>
链接,跳转到我一直在使用的文件本身。不过,这对于在一个地方查看派生类的所有方法没有帮助。
当上述方法的注释只有"正常的";注释,即使用/*
或//
,最好的做法是编写一个小过滤器(例如,参见INPUT_FILTER
与sed
或awk
或…(,在其中将(所有?(/*
///
注释转换为/**
////
,以便doxygen解析注释块。结果并不像";"满";doxygen评论。
这只是一种变通方法,当INPUT_FILTER
不排除例如字符串内部的//
时,可能会导致意外结果。