如何配置Doxygen识别标准C++注释？或求注释转换工具

一、通过Doxygen配置识别普通//注释 #

完全可以通过调整Doxygen的配置文件，让它识别你现有的单行//注释。关键配置项如下：

• JAVADOC_AUTOBRIEF = YES：开启这个选项后，Doxygen会把紧跟在类、函数、变量等代码元素紧前面的单行//注释，当作该元素的brief（简短）描述。比如你示例中的代码：

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

  开启后，Doxygen会自动把// This is a class.关联到class C，把// This is a method关联到void f()。

• MULTILINE_CPP_IS_BRIEF = YES：如果你的代码里有多行连续的//注释（比如一段描述性文字），开启这个选项可以让Doxygen将这些连续行合并成一个完整的brief块。

不过要注意这种方式的局限性：

• 如果注释和对应的代码元素之间有空行，Doxygen可能无法关联两者；
• 普通//注释没有Doxygen专属的标签（比如@param、@return），所以无法生成包含参数说明、返回值等的详细文档，只能生成简单的brief描述。

二、自动转换普通注释为Doxygen格式的工具 #

如果需要生成更完整的Doxygen文档（比如添加参数、返回值标签，转换为///或/** */格式），可以用以下工具批量处理：

• VS Code插件：Doxygen Commenter：这个插件支持一键将普通//注释转换为标准Doxygen格式，还能自动识别函数参数并生成@param标签，支持批量处理整个项目的文件，非常适合日常开发使用。
• Clang-based脚本/工具：利用Clang的AST解析能力，可以编写自定义脚本（比如用Python绑定libclang）来扫描代码中的注释，自动转换为Doxygen格式。如果需要更灵活的定制，这种方式很合适。
• Oxygenize：一个开源的Python脚本，专门用于将C/C++代码中的普通注释转换为Doxygen格式，支持识别类、函数、变量等元素的注释，能快速批量处理代码文件。

小建议 #

如果你的项目规模不大，手动修改注释会更准确（毕竟工具可能误判注释和代码的关联）；如果项目很大，先用工具批量转换，再手动检查调整细节，能节省大量时间。

内容的提问来源于stack exchange，提问作者charly_b