目录

Doxygen注释格式

块注释

2. 文件注释

3. 类定义注释

4. 常量/变量的注释

5. 函数注释

其他

按照类型来注释

1）文件注释

2）函数注释

3）类型/宏定义注释

4）枚举/结构注释

建议统一使用

/**

*……

*/

行注释建议统一使用

///…

/** …… */

由于Doxygen 对于批注是视为在解释后面的程序代码。（以上默认在解释后面的程序）

例如:

针对一些常用的指令做说明：

@file

档案的批注说明。

@author

作者的信息

@brief

用于class 或function的批注中，后面为class 或function的简易说明。

@param

格式为

@param arg_name 参数说明

主要用于函式说明中，后面接参数的名字，然后再接关于该参数的说明。

@return

后面接函数传回值的说明。用于function的批注中。说明该函数的传回值。

@retval

格式为

@retval value 传回值说明

主要用于函式说明中，说明特定传回值的意义。所以后面要先接一个传回值。然后在放该传回值的说明。

如果要批注前面的程序代码则需用下面格式的批注符号。

/*!