自己的代码风格——代码注释

来源：互联网发布：网络推广专员职业规划编辑：程序博客网时间：2024/05/17 01:24

1、头文件的注释：

/****************************** @filename:    Utilily.h* @author:      xxxx* @version:     1.0* @date:        2011-9-3* @describe:    解析Rmcp指令，将其转化为rmtp(V01.01)* @modification:无*****************************/

2、函数注释：

/** * @describe:   将rmcp的客户端请求的监测指令转换为rmtp(V01.01)* @param[in]:  nStationID 监测站ID* @param[out]:  cParamCmd Rmtp所需要的启动指令* @return:     std::string   失败返回空,否则为正真的启动参数指令* @des:    如：lmapParamValue中frequency的取值为：106MHz, 89.2MHz, 160MHz, 97.1MHz，对应输出参数vFreqOrder的取值为：2, 0, 3, 1。*/

3、使用中……

函数：

/** * @Method:     $SymbolContext$* @describe:   * @author:     xxx* @date:       $YEAR$-$MONTH$-$DAY$* @param[]:    $MethodArgName$* @return:     $SymbolType$* @des:        部分注释 如：lmapParamValue中frequency的取值为：106MHz, 89.2MHz, 160MHz, 97.1MHz，对应输出参数vFreqOrder的取值为：2, 0, 3, 1。*/

文件：

/****************************** @filename:    $FILE_BASE$.$FILE_EXT$* @author:      xxx* @version:     1.0* @date:        $YEAR$-$MONTH$-$DAY$* @describe:    * @modification:无*****************************/

0 0