一、注释语法
简单注释
单行注释: ///
多行注释: /**
文件注释
/**
* @file test.h
* @brief 测试doxygen
* @details 详细描述
* 详细描述2
* @author ...
* @email 油箱
* @version v1.1.1
* @date 2020-01-10
* @license 版权
*/
命名空间注释
类定义注释
/**
* @brief 测试命名空间
*/
变量/宏定义注释
int id_; ///< 用户ID
std::string name_; ///< 用户名
/// 用户薪水
double salary_;
函数注释
/**
* @brief 测试函数
*
* @param[in] in_argv 第一个参数
* @return 成功与否
* @retval 1 成功
* @retval 0 失败
* @attention 注意释放内存
* @warning 测试警告
* @execption 异常
*/
int func_test(const std::string& in_argv){
return 0;
}