编码规范-注释管理

4.注释
除非极其简单，否则对关键信息应有注释说明。内容包括：功能、入口/出口参数，必要时还可有备注或
补充说明。
①　注释用途：代码交流、代码阅读、代码review、新人培训、工作移交等。
②　统一采用业界的文档标准：doxygen。
③　代码进行了修改，注释需要同步修改。
④　注释内容意思要与代码保持一致。

注释分为：块注释和行注释。
块注释：

/**
*@brief     块注释内容说明
*/

行注释：变量注释一般为行注释。

//注释内容说明。

4.1.类注释
对每个类进行简单的注释说明。内容包括：类名称含义、类主要用途、作者、创建日期。
样例：

/**
 * @class       设备窗口操作类
 * @brief       操作工通过该窗口进行设备查询、设备状态、设备配置等操作
 * @author      作者名称
 * @date        创建、修改日期
 */
class RTX_MOD CDialogDev : pub