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

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。
*/

 

posted @ 2015-12-22 12:13  shmilxu  阅读(395)  评论(0编辑  收藏  举报