vs2013下自動注釋的運用


1.首先是VAssistX,可以在VS的工具下,拓展和更新里面找到,然后下載安裝即可;

以下為大家介紹一下怎么添加函數頭注釋:隨便打開一個C++的工程,找到一個方法,右擊函數名,然后依次點擊“Refacto”–>“Document Method”,這個時候函數頭注釋是不是已經出來了,很方便吧。但是這個注釋格式是默認的,可能不適合你的項目。可以在VAssistX的選項中更改顯示樣式,在VS2013中點擊 “VAssistX”–>”Visual VAssistX Options”然后選擇Suggestions,再點擊”Edit VA Snippets”,在打開的窗口中選擇Refactor Document Method,在這就可以更改你的顯示樣式了。
  1. //************************************     
  2. // 函數名稱: $SymbolName$     
  3. // 函數說明:     
  4. // 作 成 者:Mr.M     
  5. // 作成日期:$DATE$     
  6. // 返 回 值: $SymbolType$     
  7. // 參    數: $MethodArg$     
  8. //************************************  

這是我設置的,大家趕快試試吧。這個插件會大大的提高你的工作效率。

VAssistX 函數注釋和文件頭注釋模板

“VAssistX”–>”Visual VAssistX Options”然后選擇Suggestions,再點擊”Edit VA Snippets”
函數模板
/*************************************************
// Method: $SymbolName$
// Description: 
// Author: K@yee 
// Date: $DATE$
// Returns: $SymbolType$
// Parameter: $MethodArgName$
// History:
*************************************************/
 
頭文件注釋的時候,在VAssistX->Insert VA Snippet即可,選擇header comment;自定義時,在“VAssistX”–>”Visual VAssistX Options”然后選擇Suggestions,再點擊”Edit VA Snippets”,然后改為With Title Only

文件頭模板
/*************************************************
// Copyright (C), 2012-2013, CS&S. Co., Ltd.
// File name: $FILE_BASE$.$FILE_EXT$
// Author: K@yee 
// Version: 1.0 
// Date: $DATE$
// Description: 
// Others:
// History:
// <author> K@yee 
// <time> $DATE$
// <version> 1.0 
// <desc> build this moudle 
*************************************************/
但是我想新建一個格式,總是有問題,可能是插件的問題,后面又好了,怎么添加的目錄呢?直接輸入快捷鍵接好了,添加時間有直接可以選擇的,隨便自己摸索!!
 
2.可以自己編輯生成模板,暫時沒有實踐
 
3.  在VS環境中集成Doxygen工具 ,利用這個工具自動生成注釋文檔,將在下一篇總結!
 


免責聲明!

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



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