Doxygen语法简介

1970-01-01

Doxygen语法简介

所谓Doxygen语法就是在写程序注视时候按照Doxygen语法规则来写注释。只有按照标准的注释规则来写注释，生成的文档才会非常漂亮，否则乱七八糟的。

1.特殊命令简介

命令	字段名	语法
@file	文件名	file [< name >]
@brief	简介	brief { brief description }
@author	作者	author { list of authors }
@mainpage	主页信息	mainpage [(title)]
@date	年-月-日	date { date description }
@author	版本号	version { version number }
@copyright	版权	copyright { copyright description }
@param	参数	param [(dir)] < parameter-name> { parameter description }
@return	返回	return { description of the return value }
@retval	返回值	retval { description }
@bug	漏洞	bug { bug description }
@details	细节	details { detailed description }
@pre	前提条件	pre { description of the precondition }
@see	参考	see { references }
@link	连接(与@see类库，{@link www.google.com})	link < link-object>
@throw	异常描述	throw < exception-object> { exception description }
@todo	待处理	todo { paragraph describing what is to be done }
@warning	警告信息	warning { warning message }
@deprecated	弃用说明。可用于描述替代方案，预期寿命等	deprecated { description }
@example	弃用说明。可用于描述替代方案，预期寿命等	deprecated { description }

文件开头注释

/**
 * @file 文件名
 * @brief 简介
 * @details 细节
 * @author 作者
 * @version 版本号
 * @date 年-月-日
 * @copyright 版权
 */

结构体注释

1
2
3

/**
 * @brief 类的详细描述
 */

函数注释

/**
 * @brief 函数描述
 * @param 参数描述
 * @return 返回描述
 * @retval 返回值描述
 */

5.常量/变量注释

常量/变量上一行注释
常量/变量后注释

/**
 * @brief 定义一个整型变量a
*/
int a;

int a; /*!< 定义一个整型变量a */
int a; /**< 定义一个整型变量a */
int a; //!< 定义一个整型变量a
int a; ///< 定义一个整型变量a

软件官网下载：https://www.doxygen.nl/download.html
转载原文链接：https://mp.weixin.qq.com/s/do4cE-vOyQXwiDcE0_JNZA

展开全文 >>

printf占位符

1970-01-01

%A    浮点数、十六进制数字和p-记法（C99）
%c    一个字符
%d    有符号十进制整数
%e    浮点数、e-记数法
%E    浮点数、E-记数法
%f    浮点数、十进制记数法
%g    根据数值不同自动选择％f或％e．
%G    根据数值不同自动选择％f或％e.
%i 有符号十进制数（与％d相同）
%o    无符号八进制整数
%p    指针
%s    字符串
%u    无符号十进制整数
%x    使用十六进制数字0f的无符号十六进制整数
%X    使用十六进制数字0f的无符号十六进制整数
%%    打印一个百分号使用printf ()函数 printf()的基本形式： printf("格式控制字符串"，变量列表);