代码备忘录--常用的一些Doxygen格式
Posted snowsad
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了代码备忘录--常用的一些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 */
以上是关于代码备忘录--常用的一些Doxygen格式的主要内容，如果未能解决你的问题，请参考以下文章