轉載:http://blog.csdn.net/sanlinux/article/details/6332156
在VC6.0里邊,C++函數頭注釋是使用一個宏完成的,VS系列中C#在函數頭輸入三個反斜杠也會自動生成XML格式的函數頭注釋。
又懶得在VS2008中寫類似於添加函數頭的注釋,只能依靠一些工具了,今天給大家介紹VAssistX。
大家可以下載VAssistX插件,安裝的時候一定要把VS2008關掉。VAssistX在這就不多做介紹了,大家可以百度或者google之。
以下為大家介紹一下怎么添加函數頭注釋
隨便打開一個C++的工程,找到一個方法,右擊函數名,然后依次點擊“Refacto”–>“Document Method”,這個時候函數頭注釋是不是已經出來了,很方便吧。
但是這個注釋格式是默認的,可能不適合你的項目。可以在VAssistX的選項中更改顯示樣式,在VS2008中點擊 “VAssistX”–>”Visual VAssistX Options”然后選擇Suggestions,再點擊”Edit VA Snippets”
在打開的窗口中選擇Refactor Document Method,在這就可以更改你的顯示樣式了。
- //************************************
- // 函數名稱: $SymbolName$
- // 函數說明:
- // 作 成 者:Mr.M
- // 作成日期:$DATE$
- // 返 回 值: $SymbolType$
- // 參 數: $MethodArg$
- //************************************
這是我設置的,大家趕快試試吧。這個插件會大大的提高你的工作效率。
http://blog.sina.com.cn/s/blog_4aff4b970101bfqs.html
VAssistX 函數注釋和文件頭注釋模板
VAssistX->Insert VA Snippet->Eidt VA Snippets->Refactor Document Method
函數模板
/*************************************************
// Method: $SymbolName$
// Description:
// Author: K@yee
// Date: $DATE$
// Returns: $SymbolType$
// Parameter: $MethodArgName$
// History:
*************************************************/
文件頭模板
/*************************************************
// 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
*************************************************/
函數模板
/*************************************************
// Method: $SymbolName$
// Description:
// Author: K@yee
// Date: $DATE$
// Returns: $SymbolType$
// Parameter: $MethodArgName$
// History:
*************************************************/
文件頭模板
/*************************************************
// 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
*************************************************/