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#程序设计有一定的借鉴价值。

时间: 2014-09-10

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

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

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

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

C# 基础入门--注释

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

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#注释的一些使用方法浅谈

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

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

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

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#的XML两种代码注释实例说明

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

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

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

利用C#如何给PDF文档添加文本与图片页眉

前言 下面这篇文章向大家分享如何使用了免费组件Free Spire.PDF给PDF文档添加文本和图片页眉.这个组件提供了一些方法,可以帮助我们快速方便地实现此目的. 添加页眉步骤: 首先,创建一个Visual C#控制台项目,添加组件引用并使用以下命名空间. using System; using System.Drawing; using Spire.Pdf; using Spire.Pdf.Graphics; 在下列代码中,我们先定义一个SetDocumentTemplate()方法来创建一

用PHP编写PDF文档生成器

PHP一个最大的优点就是它对新技术的支持非常容易,这种语言的可扩展性使得开发人员能够很方便地添加新的模块,而且遍布世界的技术团体的支持和众多扩展模块的支持使得PHP已经成为功能最齐全的Web编程语言之  一.目前可得到的扩展模块已经能够使开发人员执行IMAP和POP3操作,可以动态产生图象和Shockwave Flash动画,进行信用卡验证,敏感数据的加密解密,还能够解析XML格式的数据.但这还不是全部,现在,又有一个新的模块可以与PHP进行绑定了,那就是PDFLib扩展模块,它能够让开发人员动

利用python程序生成word和PDF文档的方法

一.程序导出word文档的方法 将web/html内容导出为world文档,再java中有很多解决方案,比如使用Jacob.Apache POI.Java2Word.iText等各种方式,以及使用freemarker这样的模板引擎这样的方式.php中也有一些相应的方法,但在python中将web/html内容生成world文档的方法是很少的.其中最不好解决的就是如何将使用js代码异步获取填充的数据,图片导出到word文档中. 1. unoconv 功能: 1.支持将本地html文档转换为docx

C#代码实现PDF文档操作类

本文纯干货,贴上PDF文档操作类C#代码,需要添加iTextSharp.dll引用才可以正常通过编译. 废话不多说了,直接给大家贴代码了. 代码如下: using System.IO; using iTextSharp.text; using iTextSharp.text.pdf; namespace DotNet.Utilities { /// <summary> /// PDF文档操作类 /// </summary> //---------------------------

C#打印PDF文档的10种方法(小结)

操作PDF文档时,打印是常见的需求之一.针对不同的打印需求,可分多种情况来进行,如设置静默打印.指定打印页码范围和打印纸张大小.双面打印.黑白打印等等.经过测试,下面将对常见的几种PDF打印需求做一些归纳总结,这里归纳了10种打印需求及方法.如下: 使用默认打印机打印PDF文档 使用虚拟打印机(Microsoft XPS Document Writer)打印PDF文档 指定打印机及PDF文档打印页码范围 静默打印PDF文档 双面打印PDF文档 黑白打印PDF文档 打印PDF文档时选择不同的出纸盒

C# 在PDF文档中创建表格的实现方法

表格能够直观的传达数据信息,使信息显得条理化,便于阅读同时也利于管理.那在PDF类型的文档中如何来添加表格并且对表格进行格式化操作呢?使用常规方法直接在PDF中添加表格行不通,那我们可以在借助第三方组件的情况下来实现.本篇文章中将介绍如何正确使用组件Free Spire.PDF for .NET添加表格到PDF.该组件提供了两个类PdfTable和PdfGrid用于创建表格,在进行代码编辑前,需先安装,添加Spire.PDF. dll到项目程序集中,同时添加到命名空间.下面是两种方法来添加表格的

详解Java生成PDF文档方法

最近项目需要实现PDF下载的功能,由于没有这方面的经验,从网上花了很长时间才找到相关的资料.整理之后,发现有如下几个框架可以实现这个功能. 1. 开源框架支持 iText,生成PDF文档,还支持将XML.Html文件转化为PDF文件: Apache PDFBox,生成.合并PDF文档: docx4j,生成docx.pptx.xlsx文档,支持转换为PDF格式. 比较: iText开源协议为AGPL,而其他两个框架协议均为Apache License v2.0. 使用PDFBox生成PDF就像画图

Java如何设置PDF文档背景色详解

前言 一般生成的PDF文档默认的文档底色为白色,我们可以通过一定方法来更改文档的背景色,以达到文档美化以及保护双眼的作用. 以下内容提供了Java编程来设置PDF背景色的方法.包括: 设置纯色背景 设置图片背景 使用工具 Spire.PDF for Java 2.0.3 Jar文件引用: 方法一 步骤 1:在Java程序中新建一个文件夹可命名为Lib.下载安装包后,解压,将解压后的文件夹下的子文件夹lib中的Spire.Pdf.jar和Spire.Common.jar两个文件复制到新建的文件夹下