注释规范内容
1.简单注释
(1)单行注释
///
(2)多行注释
/**
2.文件注释
/**
*@file文件名
*@brief简介
*@datails细节
*@mainpage工程概览
*@autor作者
*@email邮箱
*@version版本号
*@date年-月-日
*@license版权
*/
3.常量/变量注释
(1)代码前注释
///注释
变量/常量定义
(2)代码后注释
变量/常量定义///<注释
4.函数注释
下面是函数的详细注释,可根据实际情况增减相关条目。
/**
*@brief函数简介
*@datail详细说明
*
*@param形参参数说明
*@param形参参数说明
*@return返回说明
*@retval返回值说明
*@note注解
*@attention注意
*@warning警告
*@exception异常
*/
5.其他内容注释
命令生成字段名说明
@see参考
@class应用类用于文档生成连接
@var引用变量用于文档生成连接
@enum引用枚举用于文档生成连接
@code代码块开始与@endcode成对使用
@endcode代码块接收与@code成对使用
@bug缺陷
@todo
@example使用例子说明
@remarks备注说明
@pre函数前置条件
@deprecated函数过时说明