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

OStack程序员社区-中国程序员成长平台 › 门户 › 编程› Node.js›Node.js教程

原作者: [db:作者] 来自: [db:来源] 收藏邀请

这篇文章主要介绍了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