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)

相关推荐

  • c#文件操作示例带详细注释

    复制代码 代码如下: using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.IO; namespace Example { class Program     { static void Main(string[] args)         {             ////////////////   文件打开  下面的代码打开D:\wang.tx

  • c#删除代码中的单行注释行示例

    复制代码 代码如下: using System.IO; using System.Collections; static string deleteComments(string s) //去掉以//开始的注释 { if (s == null) return s; int pos = s.IndexOf("//"); if (pos < 0) return s; return s.Substring(0, pos); }if (Directory.Exists("Tem

  • C#制作鹰眼的详细全过程(带注释)实例代码

    axMapControl1是主控件,axMapControl2是鹰眼控件 要看清楚事件响应 1.鹰眼地图资源载入 复制代码 代码如下: privatevoid axMapControl1_OnMapReplaced(object sender, IMapControlEvents2_OnMapReplacedEvent e) { //当主地图显示控件的地图更换时,鹰眼中的地图也跟随更换 axMapControl2.LoadMxFile(axMapControl1.DocumentFilename

  • C# 基础入门--注释

    注释,是代码中的一些"说明性文字".注释本身不会参与程序的编译和运行,仅仅供程序员阅读. 注释分为:单行注释.多行注释.文档注释. 单行注释的符号是2条斜线"//",2条斜线右侧的内容就是注释,左侧的代码不会受影响. 多行注释以"/*"开始,以"*/"结束,之间的内容就是注释,可以包含多行. 文档注释写在类.方法或属性的前面,它的符号是3条斜线"///". namespace Test { /// <

  • C#的XML两种代码注释实例说明

    在C/C++,JAVA中,有两种注释,一种是单行注释,即两根反斜杠(//),另一种是多行注释,即以/*开头,以*/结尾. 在Java中,多行注释(Multiline Comment)分为两种形式: 1.普通多行注释,比如 复制代码 代码如下: /* *多行注释 */ 2.Javadoc注释,比如 复制代码 代码如下: /** *Javadoc注释 */ 当Java源文件编译的时候,Javadoc工具会读取源文件当中的Javadoc注释内容,并生成相应的HTML文档.供开发者参阅API相关的内容.

  • c#中xml文档注释编译dll引用到其它项目示例

    复制代码 代码如下: <#@ template debug="True" hostspecific="True" language="C#" #><#@ assembly name="System.Core" #><#@ assembly name="System.Data" #><#@ assembly name="System.xml" #&

  • 使用C#给PDF文档添加注释的实现代码

    整理文档时,我们可能会需要在一些或一段文字上添加注释加以说明,那如何以编程的方式实现呢?本文将实例讲述C#中如何使用免费组件给PDF文档添加文本注释,包括自由文本注释.自由文本注释能允许我们自定义它的风格和外观,非常具有实用价值. 首先,下载这个免费版组件Free Spire.PDF.组件下载安装后,Visual Studio创建C#控制台项目,添加bin文件夹的.DLL作为引用以及以下命名空间: using System; using System.Drawing; using System.

  • 在C#里面给PPT文档添加注释的实现代码

    平常开会或者做总结报告的时候我们通常都会用到PowerPoint演示文稿,我们可以在单个幻灯片或者全部幻灯片里面添加注释,这样观众可以从注释内容里面获取更多的相关信息. 有些朋友不清楚如何在幻灯片里面添加注释,下面我跟大家分享一下如何在C#里面为幻灯片添加注释. 在这里我使用了一个免费控件--Free Spire.Presentation,有兴趣的朋友可以下载使用. 需要添加的命名空间: using Spire.Presentation; using System.Drawing; 详细步骤和代

  • C#注释的一些使用方法浅谈

    C# Coding的时候,常常涉及代码注释,常见的注释包括两类:1)单行注释.格式:// Comments2)多行注释.格式:/* Comments... */C#引入了新的XML注释,即我们在某个函数前新起一行,输入///,VS.Net会自动增加XML格式的注释,这里整理一下可用的XML注释.XML注释分为一级注释(Primary Tags)和二级注释(Secondary Tags),前者可以单独存在,后者必须包含在一级注释内部.I 一级注释1. <remarks>对类型进行描述,功能类似&

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

    本文实例讲述了C#实现为类和函数代码自动添加版权注释信息的方法,分享给大家供大家参考之用.具体方法如下: 以web项目为例: 一:给类加注释 1.在visual studio 的安装路径下 如:[盘符]:/Program files/Microsoft Visual Studio 8/Common7/IDE/ItemTemplates/web/cshare/2052/class.zip ,将里面的class.cs改为: /*------------------------------------

  • Unity脚本自动添加头部注释的全过程

    目录 Unity脚本自动添加头部注释 1. 修改Unity模板 2. 通过代码修改为动态的 结语 Unity脚本自动添加头部注释 就是创建.cs文件时自动添加作者名,创建时间,文件名等 看示例,我们在Unity的project面板下先创建一个Scripts文件夹,然后在Scripts文件夹下创建一个脚本,命名为:Test.cs 然后就是这样: 因为这个是我已经成功的设置过了才会有这样的头部注释 1. 修改Unity模板 首先找到你的Unity的安装路径,找到这样的文件夹,文件名字是和版本相关的

  • JavaScript实现复制文章自动添加版权

    第一种 <script type="text/javascript"> document.body.oncopy = function(){ setTimeout( function (){ var text = clipboardData.getData("text"); if(text){ text = text + "\r\n本文来自: (www.jb51.net) 详细出处参考:"+location.href; clipboa

  • python实现在函数图像上添加文字和标注的方法

    如下所示: import matplotlib.pyplot as plt import numpy as np from matplotlib import font_manager #先确定字体,以免无法识别汉字 my_font = font_manager.FontProperties(fname= "C:/Windows/Fonts/msyh.ttc") X=np.linspace(-np.pi,np.pi,100) plt.figure(figsize=(6,5)) Y_x2

  • Mybatis工具类JdbcTypeInterceptor运行时自动添加jdbcType属性

    JdbcTypeInterceptor 运行时自动添加 jdbcType 属性 拦截器签名 @Intercepts({ @Signature( type = ParameterHandler.class, method = "setParameters", args = {PreparedStatement.class}) }) 这类拦截器很少见,所以和其他拦截器(如分页插件)等搭配使用时不需要考虑顺序. 这个插件最适合的场景可能就是 Oracle 数据库,可以自动给所有方法添加 jd

  • Python实现自动添加脚本头信息的示例代码

    前言 每个人写脚本时的格式都会有所不同,有的会注明脚本本身的一些信息,有的则开门见山,这在小团队里其实没什么,基本别人做什么你也都知道,但如果放到大的团队就比较麻烦了,因为随着人数的增多,脚本成指数增长,如果每个人风格不统一,到最后就会造成非常大的弊端,所以当团队人数增长后,就必须有一套标准,形成大家统一的编码规则,这样即使不看脚本具体实现,也知道这个脚本的功能是什么. 我们今天分享的一段脚本是自动添加注释信息的脚本,添加的信息包括脚本名称.作者.时间.描述.脚本用法.语言版本.备注等,下面来看

  • 新建文件时Pycharm中自动设置头部模板信息的方法

    前言 pycharm默认是没有为我们设置模板信息的,但为了更加方便的实现代码管理,以及能够一目了然的查看到我们是什么时候写的代码,个人觉得增加一个模板信息还是很有必要的. 实现方法 依次点击 File | Settings | Editor | File and Code Templates, 然后选中python Script,在右边的输入框中填入你想要设计的模板信息即可.下面是图形实例 编辑内容 pycharm中设置了许多相应的模板信息,可以根据需要写入 $ {YEAR} #当年 $ {MO

  • ajax 返回值自动添加pre标签的解决方法

    ajax返回,自动添加pre标签 ajax返回的内容,居然自动添加了<pre>标签 在FF,ie,谷歌浏览器中,每个返回的都不一样:ff小写,ie大写,谷歌加style 查了一下,原来是返回的类型不对. 最终解决结果,修改一般处理程序的返回类型 把 context.Response.ContentType = "text/plain"; 修改为 context.Response.ContentType = "text/html";

  • phpmail类发送邮件函数代码

    有了phpmail这个类,你就不用愁了.这是个外国人写的一个类,我们就只管"拿来主义"了.下面是基于这个类里面的send()方法写的一个函数: 复制代码 代码如下: function send_mail ($title,$content,$from,$to,$charset='gbk',$attachment ='') { include '/class/PHPMail.class.php'; header('Content-Type: text/html; charset='.$ch

  • PHP操作文件类的函数代码(文件和文件夹创建,复制,移动和删除)

    复制代码 代码如下: <? /** * 操纵文件类 * * 例子: * FileUtil::createDir('a/1/2/3'); 测试建立文件夹 建一个a/1/2/3文件夹 * FileUtil::createFile('b/1/2/3'); 测试建立文件 在b/1/2/文件夹下面建一个3文件 * FileUtil::createFile('b/1/2/3.exe'); 测试建立文件 在b/1/2/文件夹下面建一个3.exe文件 * FileUtil::copyDir('b','d/e')

随机推荐