设置为在Doxygen中包含//?

时间:2015-09-18 21:04:58

标签: c++ doxygen

我有一个很大的代码库,我想用Doxygen制作第一篇文档,但它没有所需的///注释格式 - 它们都是//。是否有包含所有评论的设置?我过去曾经使用过Doxygen,并且理解为什么你们想要这两种格式,所以请不要对这些差异进行教育:)。这个问题在此之前被问过 - // comments in doxygen - 但没有回答。

1 个答案:

答案 0 :(得分:2)

你可以做几件事:

首先,让Doxygen使用EXTRACT_ALL = TRUE或同时使用HIDE_UNDOC_CLASSES = FALSEHIDE_UNDOC_MEMBERS = FALSE,从代码结构中自动生成文档。

然后,Doxygen支持预处理器。也许您可以编写过滤器,而不是自动将/*更改为/**//更改为///?根据你的代码,一个愚蠢的过滤器可能会或可能不会破坏事物(这些组合是否出现在字符串文字中,例如?)

最后,Doxygen代码并不难破解。您应该可以毫不费力地将///*视为文档。