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

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

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

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

以web項目為例:

一:給類加注釋

1.在visual studio 的安裝路徑下

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

/*---------------------------------------------------------------- 
// 版權所有。  
// 
// 文件名： 
// 文件功能描述： 
// 
//  
// 創(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: 在此處添加構造函數(shù)邏輯  
    //  
  }  
} 
/*---------------------------------------------------------------- 
// 版權所有。 
// 
// 文件名： 
// 文件功能描述： 
// 
// 
// 創(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: 在此處添加構造函數(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#程序設計有一定的借鑒價值。

您可能感興趣的文章:

C#開發(fā)Winform實現(xiàn)學生管理系統(tǒng)
這篇文章介紹了C#開發(fā)Winform實現(xiàn)學生管理系統(tǒng)的項目案例，文中通過示例代碼介紹的非常詳細。對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下
2022-05-05
C#中38個常用運算符的優(yōu)先級的劃分和理解
這只我自己在學C#中的一些總結，其中對于各級的劃分方式、各操作符的優(yōu)先級的理解并不見得正確，只是自己的看法，拿出來與大家分享
2012-08-08
C# goto語句的具體使用
# goto 語句用于直接在一個程序中轉(zhuǎn)到程序中的標簽指定的位置，標簽實際上由標識符加上冒號構成。本文主要介紹了C# goto語句的具體使用，感興趣的可以了解一下
2021-06-06
C# 9.0新特性——擴展方法GetEnumerator支持foreach循環(huán)
這篇文章主要介紹了C# 9.0新特性——擴展方法GetEnumerator支持foreach循環(huán)的相關資料,幫助大家更好的理解和學習c# 9.0，感興趣的朋友可以了解下
2020-11-11
配置C#的系統(tǒng)環(huán)境變量的方法
配置C#的系統(tǒng)環(huán)境變量的方法...
2007-03-03
字符串內(nèi)存駐留機制詳解示例
字符串內(nèi)存駐留機制詳解示例,大家參考使用吧
2013-12-12
C#?AStar尋路算法詳解
AStar算法是一種圖形搜索算法，常用于尋路。他是以廣度優(yōu)先搜索為基礎，集Dijkstra算法和最佳優(yōu)先(best?fit)于一身的一種算法，本文主要介紹了AStar尋路算法的原理與實現(xiàn)，需要的可以參考一下
2023-03-03
C# FileStream復制大文件功能
這篇文章主要為大家詳細介紹了C# FileStream復制大文件功能，具有一定的參考價值，感興趣的小伙伴們可以參考一下
2019-05-05
C#如何優(yōu)雅的結束線程
這篇文章主要介紹了C#如何優(yōu)雅的結束一個線程,本文通過示例代碼給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下
2021-05-05
C#自定義Key類型的字典無法序列化的解決方案詳解
當我們使用System.Text.Json.JsonSerializer對一個字典對象進行序列化的時候,默認情況下字典的Key不能是一個自定義的類型,本文整理了幾種解決方案,希望對大家有所幫助
2024-03-03