c++ - Doxygen:识别所有 C++ 注释

标签 c++ comments doxygen

我有一个(已完成的)项目,我为其生成了 Doxygen 文档。

问题是,注释是标准的 c++ 注释——没有特殊的 doxygen 注释。它们看起来像这样:

// This is a class.
class C
{
   // This is a method
   public: void f();   
};

那么有没有办法配置DoxyGen使用所有注释呢?如果没有,是否有可以解析代码并将注释转换为 DoxyGen-Comments 的工具?

最佳答案

您可以用正则表达式替换注释。如果您仅将 // 用于注释而不是在 "Hallo//ABC" 之类的字符串文字中使用,则可以搜索并替换为模式 /\/\/(.*)$/gm/** $1 */。在 https://regexr.com/3j7lc 查看示例

Notepad++等一些文本编辑器支持正则表达式搜索和替换。

要仅搜索在 // 之前没有文本的行,您可以使用 /^(\s*)\/\/(.*)$/gm .替换模式看起来像 $1/** $2 */

关于c++ - Doxygen:识别所有 C++ 注释,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/48265429/

相关文章:

documentation - 什么是自文档化代码?它可以取代有据可查的代码吗?

collections - 如何防止内容类型出现在集合中?

python - python 成员之后的文档(使用 doxygen)

c++ - 如何使用 bool true 参数的函数更改数组的值

C++:为什么 decltype (*this) 返回一个引用?

c++ - C++十进制转十六进制代码

documentation - 记录 C++/CLI 库代码以供 C# 使用 - 最佳工具和实践?

c++ - 如何从priority_queue中删除不在顶部的元素?

java - 使用 Checkstyle 检查评论/Javadoc 字数

c++ - 预处理器#include指令和宏扩展