注释规范

1 文件首部

/*!
* \file Ctext.h
* \brief 概述 
* 
*详细概述 
* 
* \author 作者名字
* \version 版本号(maj.min，主版本.分版本格式) 
* \date 日期 
---------------------------------------------------------
Modification History
DATE                   NAME                  DESCRIPTION
---------------------------------------------------------
2020-11-01             xxx                   xxxxx
*/

2 命名空间

/** @brief 命名空间的简单概述 
 *
 * 命名空间的详细概述
 */
namespace text
{
}

3 类

/** @brief Ctext的doxygen测试
 *
 * 作doxygen测试用
 * @code
    Ctext a;
 * @endcode
 * @note 注意事项
 */
class Ctext
{
}

4 函数

/** @brief 函数名字说明
 *
 * 详细说明
 * @param p1 -参数1
 * @param p2 -参数2
 * @return 返回值
 * @example /src/test.cpp
 * @cite 引用
 * @note 注意事项
 */
void fun(int p1, int p2) {
    return p1 + p2;
}

/**@method:  xxx
 * @brief:  详细说明
 * @param   p1 -参数1
 * @param   p2 -参数2
 * @return  void 返回值
 * @example /src/test.cpp
 * @cite 引用
 * @note 注意事项
 * @author: 函数名字说明
 * @modified by xxx, 说明修改日期和修改内容
 */
void fun(int p1, int p2) {
    return p1 + p2;
}