我可以让Doxygen在函数原型上使用未标记的注释吗?

我可以让Doxygen在函数原型上使用未标记的注释吗?,doxygen,Doxygen,我工作的公司不使用Doxygen,在他们的编码标准中明确禁止“可解析的注释样式,如javadoc等” 然而,我仍然发现自己运行Doxygen非常有用,这样我就可以看到类结构,并获得类所具有的所有方法(包括继承的方法)的良好的类文档 该公司在头文件中记录了这些类,每个方法声明上面都有简单的注释。如果我可以配置Doxygen,将这些注释视为函数描述,即使它们不以任何Doxygen标记开头,这将非常有用 那么:即使注释没有用Doxygen的“parse this comment”标记标记,是否可以让D

我工作的公司不使用Doxygen,在他们的编码标准中明确禁止“可解析的注释样式,如javadoc等”

然而,我仍然发现自己运行Doxygen非常有用,这样我就可以看到类结构,并获得类所具有的所有方法(包括继承的方法)的良好的类文档

该公司在头文件中记录了这些类,每个方法声明上面都有简单的注释。如果我可以配置Doxygen,将这些注释视为函数描述,即使它们不以任何Doxygen标记开头,这将非常有用

那么:即使注释没有用Doxygen的“parse this comment”标记标记,是否可以让Doxygen将上述声明行上的注释视为该项的描述


下一个最好的方法是单击类文件顶部的
#include
链接,跳转到我一直在使用的文件本身。但是,这对在一个位置查看派生类的所有方法没有帮助。

当方法上面的注释只有“正常”注释时,即使用
/*
/
时,最好编写一个小过滤器(例如,使用
sed
awk
或…)在其中,您将(所有?)注释转换为
/*
//注释,从而使注释块由doxygen解析。结果不如“完整”的doxygen注释好


这只是一种解决方法,当
输入过滤器
不排除例如
/
内部字符串时,可能会导致意外的结果。

奇怪的是,这样的事情是被禁止的,这背后的理由是什么,或者公司是否担心这会使代码更容易理解,或者他们是否想隐藏一些东西。。。最好是让负责人相信使用强氧剂的好处。上述方法的注释是否只有“正常”注释,即
/*
//
或从
/**
//
开始(或也是禁止的)?最好的方法可能是编写一个小过滤器(例如,请参阅
输入过滤器
),将(所有?
/*
/
/
//
注释转换为
/**
/
/
/
),以便doygen解析注释块。结果不如“完整”的doxygen评论好,但可能是你能做的最好的,在获得一些结果后,说服负责人使用doxygen。我还不知道理由是什么。这只是我在那里的第二个星期,所以我需要一段时间才能说服人们换工作。不过,输入过滤器的想法看起来很有希望。太好了!我刚刚使用了
sed
。你想把它作为一个实际的答案,这样我就可以接受了吗?确实有点难说服人们,但是你有一个带有
sed
的小模型,你需要展示一些东西。最好的可能是第一个直接的同事(在咖啡机前对着他们说话)。一个好的公司应该总是善于倾听创新/改进。我最终选择了
过滤模式
,设置为只做头文件。到现在为止,一直都还不错。