基于doxygen的C++注释规范笔记.docVIP

基于doxygen的文档注释学习笔记 文件注释 /** *@file 文件名 *@brief 概述 * *详细概述 * *@author 作者,包含email等 *@version 版本号(maj.min，主版本.分版本格式) *@data 日期 */ 命名空间的注释 ///@brief 简单概述 /// ///详细概述 类定义注释 对需要的类增加注释，需要说明类的设计方法，类的使用指南，说明类的不变项 ///@brief 简要概述 /// ///详细说明 /// ///使用指南设计函数调用可以@ref 函数名 用于引用其他的说明 /// ///其他说明，重写父类函数加以特殊实现 /// ///@invariant 类不变项，例如哪些值不会超多少多少 /// class xxx{… 数据声明注释 行尾说明 Type varName;/// 说明 多行说明 ///说明 /// /// Type varName; 函数注释规范 ///@brief 简单概述 /// ///详细说明 ///@param[in|out] 参数名，in，out表示输入还是输出 ///@pre 前者条件 ///@return 说明 ///@retval 返回值 说明, 这个是可选的 ///@post 说明函数完成后的世界状态 代码标记数值规范 ///@todo 将要做的代码 ///@bug 表示此处的bug描述