2015-09-18 31 views
0

我有一个很大的代码库,我想用Doxygen做一个第一遍文档,但它没有所需的///注释格式 - 它们都是//。是否有包含所有评论的设置?我过去使用过Doxygen,并明白为什么你会希望这两种格式,所以请不要教育差异:)。问题在这之前被问 - // comments in doxygen - 但没有回答。设置为包含//在Doxygen中?

+0

我不认为有解决方案。 “//”和“///”(或“//!”及其他)之间有区别,所以没有理由让该功能甚至存在。对我来说,感觉和编译器选项一样,例如,甚至在评论中寻找变量定义。 – Zereges

回答

2

有两件事情可以做:

首先,让Doxygen的产生哪些文件会自动就可以了,从刚代码结构,即使用EXTRACT_ALL = TRUE或两者HIDE_UNDOC_CLASSES = FALSEHIDE_UNDOC_MEMBERS = FALSE

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

最后,Doxygen代码不难被破解。您应该能够将///*作为文档很容易地识别出来。