本文實(shí)例講述了C#實(shí)現(xiàn)為類和函數(shù)代碼自動(dòng)添加版權(quán)注釋信息的方法,分享給大家供大家參考之用。具體方法如下:
以web項(xiàng)目為例:
一:給類加注釋
1.在visual studio 的安裝路徑下
如:[盤(pán)符]:/PRogram files/Microsoft Visual Studio 8/Common7/IDE/ItemTemplates/web/cshare/2052/class.zip ,將里面的class.cs改為:
| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374 | /*---------------------------------------------------------------- // 版權(quán)所有。 // // 文件名: // 文件功能描述: // // // 創(chuàng)建標(biāo)識(shí): // // 修改標(biāo)識(shí): // 修改描述: // // 修改標(biāo)識(shí): // 修改描述: //----------------------------------------------------------------*/using System; using System.Data; using System.Configuration; using System.Web; using System.Web.Security; using System.Web.UI; using System.Web.UI.WebControls; using System.Web.UI.WebControls.WebParts; using System.Web.UI.HtmlControls; /// <summary> /// $safeitemrootname$ 的摘要說(shuō)明 /// </summary> public class $safeitemrootname$ { public $safeitemrootname$() { // // TODO: 在此處添加構(gòu)造函數(shù)邏輯 // } } /*---------------------------------------------------------------- // 版權(quán)所有。 // // 文件名: // 文件功能描述: // // // 創(chuàng)建標(biāo)識(shí): // // 修改標(biāo)識(shí): // 修改描述: // // 修改標(biāo)識(shí): // 修改描述: //----------------------------------------------------------------*/using System; using System.Data; using System.Configuration; using System.Web; using System.Web.Security; using System.Web.UI; using System.Web.UI.WebControls; using System.Web.UI.WebControls.WebParts; using System.Web.UI.HtmlControls; /// <summary> /// $safeitemrootname$ 的摘要說(shuō)明 /// </summary> public class $safeitemrootname$ { public $safeitemrootname$() { // // TODO: 在此處添加構(gòu)造函數(shù)邏輯 // } } |
保存文件即可(先解壓,在修改)
二:VS宏腳本添加函數(shù)注釋模板
現(xiàn)在的IDE越做越強(qiáng)大,為我等懶人省了不少。為了使用將來(lái)的代碼自己或別人能看懂,注釋這種東西必不可少。當(dāng)為函數(shù)添加注釋時(shí),格式是固定的。每個(gè)函數(shù)寫(xiě)一遍,或從別的函數(shù)處拷貝過(guò)來(lái),即麻煩又容易出錯(cuò)。這種重復(fù)勞動(dòng)讓人心煩都有不想寫(xiě)注釋的欲望了,這時(shí)VS的宏可以干掉這些“臟、亂、累”的體力活。
看了一下,vs2010的宏腳本就是VBScript,很容易上手。我寫(xiě)了一個(gè)生成函數(shù)注釋模板的宏腳本,比較容易,看代碼: