C#實(shí)現(xiàn)為類和函數(shù)代碼自動(dòng)添加版權(quán)注釋信息的方法

更新時(shí)間：2014年09月12日 10:29:04 投稿：shichen2014

這篇文章主要介紹了C#實(shí)現(xiàn)為類和函數(shù)代碼自動(dòng)添加版權(quán)注釋信息的方法,主要涉及安裝文件的修改及函數(shù)注釋模板的修改,需要的朋友可以參考下

本文實(shí)例講述了C#實(shí)現(xiàn)為類和函數(shù)代碼自動(dòng)添加版權(quán)注釋信息的方法，分享給大家供大家參考之用。具體方法如下：

以web項(xiàng)目為例:

一:給類加注釋

1.在visual studio 的安裝路徑下

如:[盤符]:/Program files/Microsoft Visual Studio 8/Common7/IDE/ItemTemplates/web/cshare/2052/class.zip ，將里面的class.cs改為：

/*---------------------------------------------------------------- 
// 版權(quán)所有。  
// 
// 文件名： 
// 文件功能描述： 
// 
//  
// 創(chuàng)建標(biāo)識： 
// 
// 修改標(biāo)識： 
// 修改描述： 
// 
// 修改標(biāo)識： 
// 修改描述： 
//----------------------------------------------------------------*/  
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)建標(biāo)識： 
// 
// 修改標(biāo)識： 
// 修改描述： 
// 
// 修改標(biāo)識： 
// 修改描述： 
//----------------------------------------------------------------*/  
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越做越強(qiáng)大，為我等懶人省了不少。為了使用將來的代碼自己或別人能看懂，注釋這種東西必不可少。當(dāng)為函數(shù)添加注釋時(shí)，格式是固定的。每個(gè)函數(shù)寫一遍，或從別的函數(shù)處拷貝過來，即麻煩又容易出錯(cuò)。這種重復(fù)勞動(dòng)讓人心煩都有不想寫注釋的欲望了，這時(shí)VS的宏可以干掉這些“臟、亂、累”的體力活。

看了一下，vs2010的宏腳本就是VBScript，很容易上手。我寫了一個(gè)生成函數(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 -> 工具 -> 宏 -> 新建宏項(xiàng)目，選擇要保存的位置。然后將要上面的腳本復(fù)制進(jìn)去，保存即可。

具體的使用：為你編寫的宏綁定快捷鍵，vs2010 IDE -> 工具 -> 選項(xiàng) -> 在左邊列表中選擇“鍵盤” -> 在右邊的“顯示命令包含”中，選擇你創(chuàng)建宏-> 將光標(biāo)定位到”按快捷鍵”處 -> 輸入你想命名的快捷鍵，比如”Alt+C”，保存即可。

有一點(diǎn)需要注意：Visual Studio 2005 Team Suite 需要打上SP1補(bǔ)丁，宏方能使用否則無效。

相信本文所述對大家的C#程序設(shè)計(jì)有一定的借鑒價(jià)值。

您可能感興趣的文章: