C#實現(xiàn)為類和函數(shù)代碼自動添加版權(quán)注釋信息的方法
本文實例講述了C#實現(xiàn)為類和函數(shù)代碼自動添加版權(quán)注釋信息的方法,分享給大家供大家參考之用。具體方法如下:
以web項目為例:
一:給類加注釋
1.在visual studio 的安裝路徑下
如:[盤符]:/Program files/Microsoft Visual Studio 8/Common7/IDE/ItemTemplates/web/cshare/2052/class.zip ,將里面的class.cs改為:
/*---------------------------------------------------------------- // 版權(quán)所有。 // // 文件名: // 文件功能描述: // // // 創(chuàng)建標識: // // 修改標識: // 修改描述: // // 修改標識: // 修改描述: //----------------------------------------------------------------*/ 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$ 的摘要說明 /// </summary> public class $safeitemrootname$ { public $safeitemrootname$() { // // TODO: 在此處添加構(gòu)造函數(shù)邏輯 // } } /*---------------------------------------------------------------- // 版權(quán)所有。 // // 文件名: // 文件功能描述: // // // 創(chuàng)建標識: // // 修改標識: // 修改描述: // // 修改標識: // 修改描述: //----------------------------------------------------------------*/ 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$ 的摘要說明 /// </summary> public class $safeitemrootname$ { public $safeitemrootname$() { // // TODO: 在此處添加構(gòu)造函數(shù)邏輯 // } }
保存文件即可(先解壓,在修改)
二:VS宏腳本添加函數(shù)注釋模板
現(xiàn)在的IDE越做越強大,為我等懶人省了不少。為了使用將來的代碼自己或別人能看懂,注釋這種東西必不可少。當為函數(shù)添加注釋時,格式是固定的。每個函數(shù)寫一遍,或從別的函數(shù)處拷貝過來,即麻煩又容易出錯。這種重復勞動讓人心煩都有不想寫注釋的欲望了,這時VS的宏可以干掉這些“臟、亂、累”的體力活。
看了一下,vs2010的宏腳本就是VBScript,很容易上手。我寫了一個生成函數(shù)注釋模板的宏腳本,比較容易,看代碼:
Imports System Imports EnvDTE Imports EnvDTE80 Imports EnvDTE90 Imports System.Diagnostics Public Module Module1 Sub AddFunComment() Dim DocSel As EnvDTE.TextSelection DocSel = DTE.ActiveDocument.Selection DocSel.NewLine() DocSel.Text = "/*******************************************************************" DocSel.NewLine() DocSel.Text = "* 函數(shù)名稱: " DocSel.NewLine() DocSel.Text = "* 功 能: " DocSel.NewLine() DocSel.Text = "* 參 數(shù): " DocSel.NewLine() DocSel.Text = "* 返 回 值: " DocSel.NewLine() DocSel.Text = "* 作 者: Lonkil" DocSel.NewLine() DocSel.Text = "* 電子郵箱: lonkil{AT}gmail.com ( {AT} -> @ )" DocSel.NewLine() DocSel.Text = "* 創(chuàng)建日期: " + System.DateTime.Now.ToLongDateString() DocSel.NewLine() DocSel.Text = "*******************************************************************/" End Sub End Module Imports System Imports EnvDTE Imports EnvDTE80 Imports EnvDTE90 Imports System.Diagnostics Public Module Module1 Sub AddFunComment() Dim DocSel As EnvDTE.TextSelection DocSel = DTE.ActiveDocument.Selection DocSel.NewLine() DocSel.Text = "/*******************************************************************" DocSel.NewLine() DocSel.Text = "* 函數(shù)名稱: " DocSel.NewLine() DocSel.Text = "* 功 能: " DocSel.NewLine() DocSel.Text = "* 參 數(shù): " DocSel.NewLine() DocSel.Text = "* 返 回 值: " DocSel.NewLine() DocSel.Text = "* 作 者: Lonkil" DocSel.NewLine() DocSel.Text = "* 電子郵箱: lonkil{AT}gmail.com ( {AT} -> @ )" DocSel.NewLine() DocSel.Text = "* 創(chuàng)建日期: " + System.DateTime.Now.ToLongDateString() DocSel.NewLine() DocSel.Text = "*******************************************************************/" End Sub End Module
具體的創(chuàng)建步驟:vs2010 IDE -> 工具 -> 宏 -> 新建宏項目,選擇要保存的位置。然后將要上面的腳本復制進去,保存即可。
具體的使用:為你編寫的宏綁定快捷鍵,vs2010 IDE -> 工具 -> 選項 -> 在左邊列表中選擇“鍵盤” -> 在右邊的“顯示命令包含”中,選擇你創(chuàng)建宏-> 將光標定位到”按快捷鍵”處 -> 輸入你想命名的快捷鍵,比如”Alt+C”,保存即可。
有一點需要注意:Visual Studio 2005 Team Suite 需要打上SP1補丁,宏方能使用否則無效。
相信本文所述對大家的C#程序設(shè)計有一定的借鑒價值。
相關(guān)文章
淺談Visual Studio 2019 Vue項目的目錄結(jié)構(gòu)
這篇文章主要介紹了Visual Studio 2019 Vue項目 目錄結(jié)構(gòu),本文通過圖文并茂的形式給大家介紹的非常詳細,對大家的學習或工作具有一定的參考借鑒價值,需要的朋友可以參考下2020-03-03