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

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
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值