为类和函数代码自动添加版权注释信息

以web项目为例:

一:给类加注释

1.在visual studio 的安装路径下

如:[盘符]:/Program files/Microsoft Visual Studio 8/Common7/IDE/ItemTemplates/web/cshare/2052/class.zip ,将里面的class.cs改为:

C#代码 

  1. /*----------------------------------------------------------------
  2. // Copyright (C) 2010  杰赛通信规划设计院
  3. // 版权所有。
  4. //
  5. // 文件名:
  6. // 文件功能描述:
  7. //
  8. //
  9. // 创建标识:
  10. //
  11. // 修改标识:
  12. // 修改描述:
  13. //
  14. // 修改标识:
  15. // 修改描述:
  16. //----------------------------------------------------------------*/
  17. using System;
  18. using System.Data;
  19. using System.Configuration;
  20. using System.Web;
  21. using System.Web.Security;
  22. using System.Web.UI;
  23. using System.Web.UI.WebControls;
  24. using System.Web.UI.WebControls.WebParts;
  25. using System.Web.UI.HtmlControls;
  26. /// <summary>
  27. /// $safeitemrootname$ 的摘要说明
  28. /// </summary>
  29. public class $safeitemrootname$
  30. {
  31. public $safeitemrootname$()
  32. {
  33. //
  34. // TODO: 在此处添加构造函数逻辑
  35. //
  36. }
  37. }

[c#] view plaincopy

  1. /*----------------------------------------------------------------
  2. // Copyright (C) 2010  杰赛通信规划设计院
  3. // 版权所有。
  4. //
  5. // 文件名:
  6. // 文件功能描述:
  7. //
  8. //
  9. // 创建标识:
  10. //
  11. // 修改标识:
  12. // 修改描述:
  13. //
  14. // 修改标识:
  15. // 修改描述:
  16. //----------------------------------------------------------------*/
  17. using System;
  18. using System.Data;
  19. using System.Configuration;
  20. using System.Web;
  21. using System.Web.Security;
  22. using System.Web.UI;
  23. using System.Web.UI.WebControls;
  24. using System.Web.UI.WebControls.WebParts;
  25. using System.Web.UI.HtmlControls;
  26. /// <summary>
  27. /// $safeitemrootname$ 的摘要说明
  28. /// </summary>
  29. public class $safeitemrootname$
  30. {
  31. public $safeitemrootname$()
  32. {
  33. //
  34. // TODO: 在此处添加构造函数逻辑
  35. //
  36. }
  37. }

保存文件即可(先解压,在修改)

二:VS宏脚本添加函数注释模板 现在的IDE越做越强大,为我等懒人省了不少。为了使用将来的代码自己或别人能看懂,注释这种东西必不可少。当为函数添加注释时,格式是固定的。每个函数写一遍,或从别的函数处拷贝过来,即麻烦又容易出错。这种重复劳动让人心烦都有不想写注释的欲望了,这时VS的宏可以干掉这些“脏、乱、累”的体力活。

看了一下,vs2010的宏脚本就是VBScript,很容易上手。我写了一个生成函数注释模板的宏脚本,比较容易,看代码:

  1. Imports System
  2. Imports EnvDTE
  3. Imports EnvDTE80
  4. Imports EnvDTE90
  5. Imports System.Diagnostics
  6. Public Module Module1
  7. Sub AddFunComment()
  8. Dim DocSel As EnvDTE.TextSelection
  9. DocSel = DTE.ActiveDocument.Selection
  10. DocSel.NewLine()
  11. DocSel.Text = "/*******************************************************************"
  12. DocSel.NewLine()
  13. DocSel.Text = "* 函数名称: "
  14. DocSel.NewLine()
  15. DocSel.Text = "* 功    能: "
  16. DocSel.NewLine()
  17. DocSel.Text = "* 参    数: "
  18. DocSel.NewLine()
  19. DocSel.Text = "* 返 回 值: "
  20. DocSel.NewLine()
  21. DocSel.Text = "* 作    者: Lonkil"
  22. DocSel.NewLine()
  23. DocSel.Text = "* 电子邮箱: lonkil{AT}gmail.com ( {AT} -> @ )"
  24. DocSel.NewLine()
  25. DocSel.Text = "* 创建日期: " + System.DateTime.Now.ToLongDateString()
  26. DocSel.NewLine()
  27. DocSel.Text = "*******************************************************************/"
  28. End Sub
  29. End Module

[java] view plaincopy

  1. Imports System
  2. Imports EnvDTE
  3. Imports EnvDTE80
  4. Imports EnvDTE90
  5. Imports System.Diagnostics
  6. Public Module Module1
  7. Sub AddFunComment()
  8. Dim DocSel As EnvDTE.TextSelection
  9. DocSel = DTE.ActiveDocument.Selection
  10. DocSel.NewLine()
  11. DocSel.Text = "/*******************************************************************"
  12. DocSel.NewLine()
  13. DocSel.Text = "* 函数名称: "
  14. DocSel.NewLine()
  15. DocSel.Text = "* 功    能: "
  16. DocSel.NewLine()
  17. DocSel.Text = "* 参    数: "
  18. DocSel.NewLine()
  19. DocSel.Text = "* 返 回 值: "
  20. DocSel.NewLine()
  21. DocSel.Text = "* 作    者: Lonkil"
  22. DocSel.NewLine()
  23. DocSel.Text = "* 电子邮箱: lonkil{AT}gmail.com ( {AT} -> @ )"
  24. DocSel.NewLine()
  25. DocSel.Text = "* 创建日期: " + System.DateTime.Now.ToLongDateString()
  26. DocSel.NewLine()
  27. DocSel.Text = "*******************************************************************/"
  28. End Sub
  29. End Module

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

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

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

时间: 2024-08-06 03:44:36

为类和函数代码自动添加版权注释信息的相关文章

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

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

让Visual Studio 自动添加头部注释信息

在日常的开发过程中我们经常需要为我们的类文件添加注释和版权等信息,以前都是将信息文本复制.粘贴,要是添加一两个个还好,要是添加很多就显得很麻烦了.为了减少这种重复性的工作,有没有好的解决办法呢?答案是肯定的,其实我们每次添加的文件都是按照类库模板自动生成的,所以只需要修改Visual Studio的类库模板就可以了. 首先找到Visual Studio(2005.2008.2010) 的安装路径下\Common7\IDE\ItemTemplatesCache\CSharp\目录,面有好多目录,W

修改VS类模板自动添加public修饰符和版权注释信息

在开发过程中,我们经常需要给类或接口添加public修饰符(默认没有)和一些相关的注释信息,这个工作是机械而枯燥的,而这个简单的需求其实是可以通过修改VS自带的类模板来实现的,下面是详细的修改步骤. 1,找到目录C:\Program Files (x86)\Microsoft Visual Studio 10.0\Common7\IDE\ItemTemplates\CSharp\Code\1033,找到class.zip文件并备份.[备份是可选操作] 2,打开该压缩文件并进一步打开其中的Clas

VS2010自动添加版权信息

原文:http://www.cnblogs.com/justconnor/archive/2013/04/07/3006331.html   自动生成版权信息设置 现在大多数公司都规定程序员在程序文件的头部加上版权信息如下: /****************************************************************** * Copyright (C): **公司 * NameSpace: Test * FileName: WebForm4 * Create

自动添加版权信息(修改类模板文件、窗体模板文件)

1.首先在记事本中准备版权文本信息 2.修改类模板文件(分窗体和WEB类模板) 1)窗体类模板(通用窗体类模板) 修改路径为:%vs%\Common7\IDE\ItemTemplatesCache\CSharp\Code\2052\Class\Class.cs (注意Code文件夹下会有1033是英文版,中文版是2052,%vs%为你的VS安装路径) 2)WEB类模板(ASP.NET MVC WEBSERVICE等项目时新建的类模板) 修改路径为:%vs%\Common7\IDE\ItemTem

网狐SQL常用脚本自动添加子游戏信息棋牌平台架设教程

好久没写了,这次给大家说个用SQL脚本自动添加子游戏每次新装好环境后,增加子游戏是个重复的劳动,很麻烦,怎么能让他自动生成呢.下面我们就用SQL脚本来解决. 将下面代码写入记事本,保存成 " 游戏ID.SQL".USE QPPlatformDBGOTRUNCATE TABLE GameGameIteminsert into GameGameItem(GameID, GameName, SupporType, DataBaseAddr, DataBaseName, ServerVersi

如何给代码自动添加注释?

丰富的注释和良好的代码规范,对于代码的阅读性和可维护性起着至关重要的作用.几乎每个公司对这的要求还是比较严格的,往往会形成自己的一套编码规范.但是再实施过程中,如果全靠手动完成,不仅效率低下,还难以保证真正的符合规范.所以结合IDE环境,自动生成注释,还是很有必要的. 见如下操作步骤: 打开 Eclipse,菜单 Window -> Preference -> Java -> Code Style -> Code Template,在右边选择 Comments -> Type

vs2013 新增类默认public,自动添加注释

C:\Program Files (x86)\Microsoft Visual Studio 12.0\Common7\IDE\ItemTemplatesCache\CSharp\Code\2052\Class Class.cs /* ============================================================================== * 类名称:$safeitemrootname$ * 类描述: * 创建人:$username$ * 创建

[Python]PyCharm在创建py文件时自动添加头部注释

在Pycharm主界面找到 File ----->> Setting ----->> Editor ----->> File and Code Templates ----->> Python Script 如图界面 在右部编辑区域输入 1 #!/usr/bin/env python 2 # -*- coding: utf-8 -*- 3 # @File : ${NAME}.py 4 # @Author: auther's name 5 # @Date :