前段時間在用devcpp時,發現他有個插入快捷鍵,可以自定義注釋模板,直接插入即可,感覺很方便。
但是我偏向於VS,所以就在CSDN上提問了,很高興的找到了我需要的答案---自定義宏注釋模板。
這裡和大家分享下(雖然網上講的很多了。。。)
程序注釋的重要性毋庸置疑,一個大型的項目通常情況下都是幾個軟件工程師合作出來的成果,假如該項目中的代碼注釋不全,那會給將來的維護者帶來無窮無盡的隱患。
通用的辦法是給自己工程裡面的函數添加注釋——使用宏。
1.打開Visual Studio 2008(2005一樣適用)開發工具,單擊“工具→宏→新建宏項目”,然後按照步驟建立注釋宏,添加如下代碼並保存。
2.打開 菜單 –> 工具–>選項 –> 鍵盤 ,在列表框中選擇剛才添加的Macro,然後在 按快捷鍵中輸入快捷鍵,點擊”分配” 。
注釋宏的代碼如下:
Sub AddFunComment()
Dim DocSel As EnvDTE.TextSelection
DocSel = DTE.ActiveDocument.Selection
DocSel.NewLine()
DocSel.Text = "/*******************************************************************"
DocSel.NewLine()
DocSel.Text = "* 函數名稱:"
DocSel.NewLine()
DocSel.Text = "* 功 能:"
DocSel.NewLine()
DocSel.Text = "* 參 數:"
DocSel.NewLine()
DocSel.Text = "* 返 回 值:"
DocSel.NewLine()
DocSel.Text = "* 作 者: Tanky Woo"
DocSel.NewLine()
DocSel.Text = "* 博 客: (1)www.WuTianQi.com | (2)www.TankyWoo.com"
DocSel.NewLine()
DocSel.Text = "* 電子郵箱:[email protected]"
DocSel.NewLine()
DocSel.Text = "* 日 期:" + System.DateTime.Now.ToLongDateString()
DocSel.NewLine()
DocSel.Text = "*******************************************************************/"
End Sub
很簡單的就完成了。大家也快點去把自己的編輯器添加注釋模板吧!