使用Visual Assistant X建立C程序注释模板

　　本文将讲解C程序注释模板的使用背景、建立方法，并在结束时进行总结。

一、使用背景

　　在项目开发过程当中，为方便组内其余成员可以快速学习本身编写的代码，须要对本身写的函数添加注释。在正规的软件开发流程中，一个标准的函数及其注释可能以下所示。

/************************************************************************
        Function:       ParseBinFile     

        Description:    解析Bin文件数据 

        Parameter:      binFileNameLen    --[in]    bin文件名长度
                        binFileName        --[in]  bin文件名
                        resultDataLen    --[out]    目标数据长度
                        resultData        --[out]    目标数据

        Return:         0,      执行成功
                       非0,        执行失败

************************************************************************/
int ParseBinFile(int binFileNameLen,char *binFileName,int resultDataLen, char *resultData)
{
    return 0;
}

View Code

　　若是在项目中须要推广函数+注释这种编程规范，那么最笨最简单的方法是：手写一个通用的注释段，而后依次进行copy，可是这种方法须要大量的手动操做，既低效又易出错。

　　若是使用的是Java语言，那么能够采用现成的Javadoc工具，为每个类、方法添加注释模板，其格式以下所示：

　　

/**   
 
* The doGet method of the servlet.   
 
* This method is called when a form has its tag value method equals to get.   
 
*   
 
* @param request   
 
* the request send by the client to the server   
 
* @param response   
 
* the response send by the server to the client   
 
* @throws ServletException   
 
* if an error occurred   
 
* @throws IOException   
 
* if an error occurred   
 
*/     
  
public   void  doGet (HttpServletRequest request, HttpServletResponse response)    
  
throws  ServletException, IOException {    
  
doPost(request, response);    
  
}    

View Code

　　Visual C++6.0中不具有像Javadoc这样注释自动生成工具，那么只能依靠插件Visual AssistantX进行辅助。

二、建立方法

　　2.一、在Visual C++6.0中安装Visual Assistant X；

　　a、找到破解版Visual Assitant X（一个小的软件下载网站），笔者用的版本是V10.0.1233.0；

　　b、直接点击Setup目录下的VA_X_Setup1230.exe进行安装；

　　c、将CR目录下的文件拷贝至安装路径，双击VA_X.reg，进行注册表注册；

　　2.二、编写注释模板；

　　a、打开Visual Assistant X的工具栏，点击Visual Assistant X Option，选择“Autotext/Templates”

　　

　　b、在右侧页面中添加注释模板。注意：代码中FF是模板结束标志，等同于上图中FF

 

/*+:
/************************************************************************
        Function:            

        Description:        

        Parameter:          --[in]  
                            --[out] 
                            --[in/out]

        Return:         0,      SUCCESS
                       Other,   FAILURE

        Note:

        Others:

        Attention:
************************************************************************/FF

View Code

 

　　2.三、实例应用；

　　在VC++6.0中打开一个C源文件，敲击/*+，便可自动生成注释：

三、总结

　　充分利用Visual Assistant 中的模板功能，能够拓展VC++6.0的功能，让代码编写更加简单、快捷。