您的位置：首页 > 编程语言

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

2016-03-08 21:37 337 查看
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:无
*****************************/



                                            

                                        

                        
                        内容来自用户分享和网络整理，不保证内容的准确性，如有侵权内容，可联系管理员处理 点击这里给我发消息 
                    

                    

                    

                        

                         标签： 
                                                

                        

                    


                

            


            

                
相关文章推荐

                

                
            

        

        

            

            
            

                

                    
新的分享

                    

                        
                    

                

            


            

                

                    
章节导航