使用Visual Studio擴展插件Visual assist X給代碼插入注釋模板


  Visual Assist 是由Whole Tomato公司為Microsoft Visual Studio開發的一款插件。它對Visual Studio的智能提示功能和代碼高亮功能進行了增強,同時還增加了代碼提示功能和重構功能,並對程序注釋加入了拼寫檢查功能。它還可以檢測一些基本的語法錯誤,如使用未聲明的變量等。

  今天使用這款插件,主要是為了能夠進行快速插入注釋模板。一個是為了提高編碼效率,不用每次都手動一行一行的添加注釋;另一個是為了規范代碼,因為插入的是模板,保證了注釋的一致性,提高代碼可讀性。

  插件的安裝環境如下:

  (1)操作系統:windows 10

  (2)IDE:Visual Studio 2012

  (3)插件版本:Visual Assist X 2089

  安裝好插件后,在VS的菜單欄中會出現VASSISTX的菜單選項,直接點擊“Insert VA Snippet...”,在彈出的選項框中點擊“Edit VA Snippets...”即可進入自定義模板對話框。如下圖所示:(也可按照:VASSIATX -> Visual Assist Options...打開設置對話框,在對話框右側點擊“Suggestions”,再選擇“Edit VA Snippets...”)

 

   在這個編輯器中,用戶可以自己定義模板,VA中也有預先定義的一些模板,在上圖左框中可以看到。其中加粗黑體是模板的Title,而灰色顯示則是快捷輸入。當你在寫代碼的過程中輸入灰色字體部分,即可聯想出黑色粗體對應的模板,按回車鍵即可插入到代碼中,大大方便了代碼的編寫。例如,輸入#in按回車,即可輸入#include “”等等。

  當需要自己定義模板時,點擊左上角的新建,在對話框右側填寫相應的內容。其中,Title是給用戶看的,表示這個新建的模板的主題;Shortcut是給IDE“看”的,當你在IDE中輸入Shortcut中的內容,就會聯想出下面的模板,按回車即可插入,即Shortcut是你想輸入什么內容來告訴IDE你想在代碼中插入下面編寫的模板。Description同樣是給用戶看的,方便用戶管理模板。

  下面是我用到的函數注釋模板,包含函數名、作者、日期、輸入、輸出、最后修改時間等信息,其代碼如下:

/*****************************************************************************
* @function name : $brief$
* @author : xiongmao
* @date : $YEAR$/$MONTH$/$DAY$ $HOUR$:$MINUTE$
* @inparam : 
* @outparam : 
* @last change : 
*****************************************************************************/

 

   在IDE中輸入mark並回車,即可插入如下圖所示的函數注釋

   Visual Assist X 提供了豐富的宏,為了定義適合自己的模板,讀者可以自行到官網或者搜索引擎查詢VAX宏的含義。

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM