C#实现为类和函数代码自动添加版权注释信息的方法

本文实例讲述了c#实现为类和函数代码自动添加版权注释信息的方法，分享给大家供大家参考之用。具体方法如下：

以web项目为例:

一:给类加注释

1.在visual studio 的安装路径下

如:[盘符]:/program files/microsoft visual studio 8/common7/ide/itemtemplates/web/cshare/2052/class.zip ，将里面的class.cs改为：

/*---------------------------------------------------------------- 
// 版权所有。  
// 
// 文件名： 
// 文件功能描述： 
// 
//  
// 创建标识： 
// 
// 修改标识： 
// 修改描述： 
// 
// 修改标识： 
// 修改描述： 
//----------------------------------------------------------------*/  
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: 在此处添加构造函数逻辑  
    //  
  }  
} 
/*---------------------------------------------------------------- 
// 版权所有。 
// 
// 文件名： 
// 文件功能描述： 
// 
// 
// 创建标识： 
// 
// 修改标识： 
// 修改描述： 
// 
// 修改标识： 
// 修改描述： 
//----------------------------------------------------------------*/  
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: 在此处添加构造函数逻辑 
    // 
  } 
} 

保存文件即可(先解压，在修改)

二:vs宏脚本添加函数注释模板

现在的ide越做越强大，为我等懒人省了不少。为了使用将来的代码自己或别人能看懂，注释这种东西必不可少。当为函数添加注释时，格式是固定的。每个函数写一遍，或从别的函数处拷贝过来，即麻烦又容易出错。这种重复劳动让人心烦都有不想写注释的欲望了，这时vs的宏可以干掉这些“脏、乱、累”的体力活。

看了一下，vs2010的宏脚本就是vbscript，很容易上手。我写了一个生成函数注释模板的宏脚本，比较容易，看代码：

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 = "* 函数名称： " 
    docsel.newline()  
    docsel.text = "* 功  能： " 
    docsel.newline()  
    docsel.text = "* 参  数： " 
    docsel.newline()  
    docsel.text = "* 返 回 值： " 
    docsel.newline()  
    docsel.text = "* 作  者： lonkil" 
    docsel.newline()  
    docsel.text = "* 电子邮箱： lonkil{at}gmail.com ( {at} -> @ )" 
    docsel.newline()  
    docsel.text = "* 创建日期： " + 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 = "* 函数名称： " 
    docsel.newline() 
    docsel.text = "* 功  能： " 
    docsel.newline() 
    docsel.text = "* 参  数： " 
    docsel.newline() 
    docsel.text = "* 返 回 值： " 
    docsel.newline() 
    docsel.text = "* 作  者： lonkil" 
    docsel.newline() 
    docsel.text = "* 电子邮箱： lonkil{at}gmail.com ( {at} -> @ )" 
    docsel.newline() 
    docsel.text = "* 创建日期： " + system.datetime.now.tolongdatestring() 
    docsel.newline() 
    docsel.text = "*******************************************************************/" 
  end sub 
end module

具体的创建步骤：vs2010 ide -> 工具 -> 宏 -> 新建宏项目，选择要保存的位置。然后将要上面的脚本复制进去，保存即可。

具体的使用：为你编写的宏绑定快捷键，vs2010 ide -> 工具 -> 选项 -> 在左边列表中选择“键盘” -> 在右边的“显示命令包含”中，选择你创建宏-> 将光标定位到”按快捷键”处 -> 输入你想命名的快捷键，比如”alt+c”，保存即可。

有一点需要注意：visual studio 2005 team suite 需要打上sp1补丁，宏方能使用否则无效。

相信本文所述对大家的c#程序设计有一定的借鉴价值。