Doxygen常用注释规则

• Doxygen 是一款在软件开发中广泛使用的文档生成工具。它通过解析类、函数和变量的相关信息，自动从源代码注释生成文档，并以 HTML 和 PDF 等格式输出。
• 通过简化和标准化文档流程，Doxygen 加强了不同编程语言和项目规模下的协作和维护。
• Doxygen 可以生成多种输出格式的文档，如 HTML、PDF (通过 LaTeX)、Word (通过 RTF) 和 XML。
• Doxygen 可以生成类层次结构和协作图的图形表示，从而提供类和函数之间关系的直观概览。

Doxygen 官网地址

文件注释通常放在整个文件开头。

项目注释, 注释一次就行，可以放到某一个入口文件当中

///////////////////////////////////////////////////////////////////////////

/// @mainpage 项目注释

/// @author 作者

/// @version 版本

/// @date 2024 年 08 月 31 日

///////////////////////////////////////////////////////////////////////////

文件注释

///////////////////////////////////////////////////////////////////////////

/// @file 文件名

/// @brief 简介

/// @details 细节

///////////////////////////////////////////////////////////////////////////

///////////////////////////////////////////////////////////////////////////

/// @brief 类的简单概述

/// @details 类的详细概述

///////////////////////////////////////////////////////////////////////////

/// 代码前注释

常量/变量

常量/变量  /// 代码后注释，一般是变量数量较多，并且名字短

///////////////////////////////////////////////////////////////////////////

/// @brief 函数简介

///

/// @param 形参 参数说明

/// @param 形参 参数说明

/// @return 返回说明

///////////////////////////////////////////////////////////////////////////

下载链接为Doxygen

项目设置为中文

总的来说，Doxygen 是一个强大的工具，可以帮助开发人员自动生成详细的软件文档，提高代码的可读性和可维护性。通过良好的注释和适当的配置，可以生成结构化清晰的文档，为团队合作和代码维护提供便利。