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

OStack程序员社区-中国程序员成长平台 › 门户 › 编程› c#›C#教程

原作者: [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

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

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

有一点需要注意：Visual Studio 2005 Team Suite 需要打上SP1补丁，宏方能使用否则无效。

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

鲜花

握手

雷人

路过

鸡蛋

该文章已有0人参与评论

请发表评论

全部评论

专题导读

More+

10-27 六六分期app的软件客服如何联系？(六六分期

11-06 可心卡盟:win10系统火狐flash插件崩溃怎么

11-06 亲亲特价:怎么删除回收站图标

11-06 济南大学虚拟社区:鲁大师节能降温的具体办

11-06 xlueops.exe:无线网络安装向导

11-06 女斗合众国:win7系统cf与主机连接不稳定怎

11-06 0xc000022-[cf烟雾头]cf怎么调烟雾头

11-06 qizideyouhuo:应用程序无法正常启动0xc0000

11-06 ipz-185:win7系统vcf文件怎么打开

11-06 傻哥蹦迪:win10系统s4怎么打开usb调试

11-06 八神浩树gtaste:回收站清空了怎么恢复

11-06 妖尾之黑色守护:win10系统电脑没有1440x900

11-06 校园至尊魔王小说:win7系统浏览网页时字体

11-06 女斗合众国:win10系统访问共享文件夹提示请

11-06 tokyo hot n0654:恢复win7系统默认字体一招

11-06 雨酷仙境:设置win7系统转移临时文件夹腾出

11-06 阿穆纳伊之杖:win7系统开始菜单在右边还原

11-06 tunespotting:win10系统火狐flash插件总是

11-06 甘尔葛分析师：计谋网站seo关键词暴涨有什

11-06 蔡贵霖: 计谋网站seo关键词暴涨有什么秘密

11-06 博益网首页:ao3网页版进入不了解决方法

11-06 漏斗子专栏: 网站数据分析小白易懂精华篇

11-06 见证双虹怎么做:win7系统开启telnet命令的

11-06 颾狐蝶蜋:系统资源不足无法完成请求的服务

11-06 国光中学校歌:提交网站到alexa查询详细步骤

11-06 西安有情天:静态网页和动态网页的区别

11-06 红木雅尚斋:外部链接构造对网站的好处

11-06 前官礼遇：防止域名劫持–增强域安全性的10

11-06 密传二转答案: 中文分词算法有哪些

11-06 金泉家园邮编:百度快照劫持的表现及应对方

C#读INI文件发布时间：2022-07-10

C#中线程的一些认识发布时间：2022-07-10

剪的笔顺,诠释剪的笔画,认识剪的部首

1 六六分期app的软件客服如何联系？(六六分期

六六分期app的软件客服如何联系？不知道吗？加qq群【895510560】即可！标题：六六分期

阅读：19165|2023-10-27

2 可心卡盟:win10系统火狐flash插件崩溃怎么

今天小编告诉大家如何处理win10系统火狐flash插件总是崩溃的问题，可能很多用户都不知

阅读：9981|2022-11-06

3 亲亲特价:怎么删除回收站图标

今天小编告诉大家如何对win10系统删除桌面回收站图标进行设置，可能很多用户都不知道

阅读：8320|2022-11-06

4 济南大学虚拟社区:鲁大师节能降温的具体办

今天小编告诉大家如何对win10系统电脑设置节能降温的设置方法，想必大家都遇到过需要

阅读：8690|2022-11-06

5 xlueops.exe:无线网络安装向导

我们在使用xp系统的过程中,经常需要对xp系统无线网络安装向导设置进行设置，可能很多

阅读：8634|2022-11-06

6 女斗合众国:win7系统cf与主机连接不稳定怎

今天小编告诉大家如何处理win7系统玩cf老是与主机连接不稳定的问题，可能很多用户都不

阅读：9650|2022-11-06

7 0xc000022-[cf烟雾头]cf怎么调烟雾头

电脑对日常生活的重要性小编就不多说了，可是一旦碰到win7系统设置cf烟雾头的问题，很

阅读：8617|2022-11-06

8 qizideyouhuo:应用程序无法正常启动0xc0000

我们在日常使用电脑的时候，有的小伙伴们可能在打开应用的时候会遇见提示应用程序无法

阅读：7994|2022-11-06

9 ipz-185:win7系统vcf文件怎么打开

今天小编告诉大家如何对win7系统打开vcf文件进行设置，可能很多用户都不知道怎么对win

阅读：8648|2022-11-06

10 傻哥蹦迪:win10系统s4怎么打开usb调试

今天小编告诉大家如何对win10系统s4开启USB调试模式进行设置，可能很多用户都不知道怎

阅读：7531|2022-11-06

客服电话

电子邮件

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

请发表评论

全部评论

上一篇：

下一篇：

百度指数公开版:怎样提高原创文章的收录

dustinvtran/ml-videos: A collection of v

ravikumar001/maven

更的笔顺,体会更的笔画,理会更的部首

ceejbot/LOUDBOT: AUTOMATED SHOUTING FOR

剪的笔顺,诠释剪的笔画,认识剪的部首

六六分期app的软件客服如何联系？(六六分期

florent37/ViewAnimator: A fluent Android

florent37/Shrine-MaterialDesign2: implem

CVE-2020-36276

SimpleSoftwareIO/simple-sms: Send and re

关于我们

产品与服务

解决方案

139-2527-9053