使用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的功能，讓代碼編寫更加簡單、快捷。