代码备忘录--常用的一些Doxygen格式
1.文件头的格式:
/** **************************************************************************** * @file xxx.cpp * @author xxx * @version V 1.0.0 * @date 15-10-2019 * @brief xxx **************************************************************************** */
2.函数的注释:
/** ******************************************************************************* * * @brief xxx * @brief xxx * @param [xx] xxx * @return xxx * @retval [FunctionResult::SUCCESS] xx fail * @retval [FunctionResult::SUCCESS] xx success * ******************************************************************************* */
3.定义变量时的注释(放到变量那行的末尾):
/**< xxx */
4.官方文档说明