当前位置:  编程技术>.net/c#/asp.net

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

    来源: 互联网  发布时间:2014-11-03

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

本文实例讲述了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;  
 
///   
/// $safeitemrootname$ 的摘要说明  
///   
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; 
 
///  
/// $safeitemrootname$ 的摘要说明 
///  
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#程序设计有一定的借鉴价值。


    
 
 

您可能感兴趣的文章:

  • c#通过委托delegate与Dictionary实现action选择器代码举例
  • C#实现获取枚举中元素个数的方法
  • C#实现自定义双击事件
  • C#键盘输入回车键实现点击按钮效果的方法
  • C#实现获取一年中是第几个星期的方法
  • C#实现Datatable排序的方法
  • C#实现装箱与拆箱操作简单实例
  • 解决C#中WebBrowser的DocumentCompleted事件不执行的实现方法
  • C#下实现创建和删除目录的实例代码
  • 使用C#实现在屏幕上画图效果的代码实例
  • C#实现过滤html标签并保留a标签的方法
  • c#实现TextBox只允许输入数字
  • C# Winform 整个窗口拖动的实现代码
  • c# ListView实现双击Item事件的变通方法
  • C#实现随鼠标移动窗体实例
  • C#中的FileUpload 选择后的预览效果具体实现
  • C# 窗体隐藏及任务管理器中禁止关闭的实现代码
  • C#的锯齿数组以及C++实现代码
  • C#格式化文件大小的实现代码
  • C#怎样才能实现窗体最小化到托盘呢?
  • C# char类型字符转换大小写的实现代码
  • Python实现多行注释的另类方法
  • 实现去除c语言注释的小工具
  • php实现图形显示Ip地址的代码及注释
  •  
    本站(WWW.)旨在分享和传播互联网科技相关的资讯和技术,将尽最大努力为读者提供更好的信息聚合和浏览方式。
    本站(WWW.)站内文章除注明原创外,均为转载、整理或搜集自网络。欢迎任何形式的转载,转载请注明出处。












  • 相关文章推荐
  • sharepoint 2010 使用STSNavigate函数实现文件下载举例
  • 谁帮我看一下下面几个实现函数需要实现要用到什么函数?在线等待,必给分!
  • Linux下c函数dlopen实现加载动态库so文件代码举例
  • 标准C下没有字符处理函数,怎样写一个实现下面功能的函数?
  • Linux下C语言strstr()查找子字符串位置函数详细介绍(strstr原型、实现及用法)
  • EJB QL都支持什么函数啊?能不能支持trim函数呢?如果不能,应该怎么实现这样的功能呢?
  • php通过pack和unpack函数实现对二进制数据封装及解析
  • sendfile()函数为什么效率高? 它的实现难道没有涉及普通I/O函数么
  • Linux有定时器函数吗?是不是要自己实现?如果有的话是什么函数呢?谢谢
  • 自己实现strcpy函数的实现方法
  • C语言应用程序使用的函数来源于libc库, Libc库中的函数是在哪里实现的??
  • 高手帮帮忙!vi中如何实现跳转到任意结构体或函数的声明处,包括系统库中声明的函数和数据结构?
  • 如何实现Java下的回调函数!
  • 怎样从Linux源文件中找到函数实现方式?
  • 关于内核里实现的函数
  • 可不可以在程序中直接使用ftp客户端的函数实现文件传输?
  • 整型数据做函数的参数,怎样实现传地址,和调用程序共用一个地址?
  • 请问如何查看libX11.so中的函数实现
  • 菜鸟问题:linux各个函数的实现源代码在哪?
  • linux下c++怎样实现回调(CALLBACK)函数?
  • 请问,pipe()这个管道建立函数在哪里实现的?
  • 通过javascript实现DIV居中,兼容各浏览器版本
  • socket实现多文件并发传输,求助多线程实现问题?
  • Python GUI编程:tkinter实现一个窗口并居中代码
  • interface 到底有什么用???实现接口,怎么实现??
  • 通过javascript库JQuery实现页面跳转功能代码
  • 怎么用Jsp实现在页面实现树型结构?
  • 编程技术其它 iis7站长之家
  • windows 下的PortTunnel 在linux下怎么实现?或者相应的已经实现的软件?端口映射
  • flash AS3反射实现(describeType和getDefinitionByName)
  • 网站重定向用C语言实现iptables,ACL实现


  • 站内导航:


    特别声明:169IT网站部分信息来自互联网,如果侵犯您的权利,请及时告知,本站将立即删除!

    ©2012-2021,,E-mail:www_#163.com(请将#改为@)

    浙ICP备11055608号-3