【问题标题】:Setting to include // in Doxygen?设置在 Doxygen 中包含 //?
【发布时间】:2015-12-16 03:13:50
【问题描述】:

我有一个大型代码库,我想用 Doxygen 制作第一次通过文档,但它没有所需的 /// 注释格式——它们都是 //。是否有包含所有 cmets 的设置?我过去使用过 Doxygen 并理解为什么您需要这两种格式,所以请不要对差异进行任何教育:)。之前在这里问过这个问题 - // comments in doxygen - 但没有回答。

【问题讨论】:

  • 我认为没有解决方案。 /////(或 //! 等)之间存在差异,因此该功能甚至没有理由存在。对我来说,感觉就像拥有一个编译器选项一样,例如即使在 cmets 中也能查找变量定义。

标签: c++ doxygen


【解决方案1】:

你可以做几件事:

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

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

最后,Doxygen 代码不难破解。您应该能够轻松地将///* 识别为文档。

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 2013-02-07
    • 1970-01-01
    • 1970-01-01
    • 2012-09-07
    • 1970-01-01
    • 2013-07-07
    • 2013-11-30
    • 1970-01-01
    相关资源
    最近更新 更多