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

在日常的开发过程中我们经常需要为我们的类文件添加注释和版权等信息,以前都是将信息文本复制、粘贴,要是添加一两个个还好,要是添加很多就显得很麻烦了。为了减少这种重复性的工作,有没有好的解决办法呢?答案是肯定的,其实我们每次添加的文件都是按照类库模板自动生成的,所以只需要修改Visual Studio的类库模板就可以了。

首先找到Visual Studio(2005、2008、2010) 的安装路径下\Common7\IDE\ItemTemplatesCache\CSharp\目录,面有好多目录,Windows Forms是开发Windows Forms程序的模版目录,Web是Web项目文件的模版目录,其他的同理。进入Web目录有选择2052目录(2052是中文地区的代号)下,会看到好多带有.zip的目录,比如要修改web页面的模版,就修改\WebForm.zip\Default.aspx.cs,打开Default.aspx.cs会看到如下内容。

  1. using System;

  2. using System.Collections.Generic;  
  3. $if$ ($targetframeworkversion$ == 3.5)using System.Linq;  
  4. $endif$using System.Web;  
  5. using System.Web.UI;  
  6. using System.Web.UI.WebControls;  
  7. namespace $rootnamespace$

  8. {  
  9. public partial class $classname$ : System.Web.UI.Page  
  10. {  
  11. protected void Page_Load(object sender, EventArgs e)  
  12. {  
  13. }

  14. }  
  15. }

代码中的"$"符号之间的字符是模版的变量,具体变量含义请参照:

  1. <strong>time$ 日期

  2. $year$ 年份

  3. $clrversion$ CLR版本

  4. $GUID$ 用于替换项目文件中的项目 GUID 的 GUID。最多可以指定 10 个唯一的 GUID(例如,guid1))。

  5. $itemname$ 用户在对话框中提供的名称。

  6. $machinename$ 当前的计算机名称(例如,Computer01)。

  7. $projectname$ 用户在对话框中提供的名称。

  8. $registeredorganization$ HKLM\Software\Microsoft\Windows NT\CurrentVersion\RegisteredOrganization 中的注册表项值。

  9. $rootnamespace$ 当前项目的根命名空间。此参数用于替换正向项目中添加的项中的命名空间。

  10. $safeitemname$ 用户在“添加新项”对话框中提供的名称,名称中移除了所有不安全的字符和空格。

  11. $safeprojectname$ 用户在“新建项目”对话框中提供的名称,名称中移除了所有不安全的字符和空格。

  12. $time$ 以 DD/MM/YYYY 00:00:00 格式表示的当前时间。

  13. $userdomain$ 当前的用户域。

  14. $username$ 当前的用户名。

  15. </strong>

我的一个注释示例:

  1. /************************************************************************

  2. * 项目名称 :  工作日志系统   
  3. * 项目描述 :       
  4. * 类 名 称 :  UserInfo     
  5. * 版 本 号 :  v1.0.0.0   
  6. * 说    明 :  用户信息管理类     
  7. * 作    者 :  灵雨飘零   
  8. * 创建时间 :  2011/12/15 13:19:28  
  9. * 更新时间 :  2011/12/15 13:19:28  
  10. ************************************************************************  
  11. * Copyright @ 灵雨工作室 2011 . All rights reserved.  
  12. ************************************************************************/

按照上面的实例设计模板:

  1. /************************************************************************

  2. * 项目名称 :  $rootnamespace$  
  3. * 项目描述 :     
  4. * 类 名 称 :  $safeitemrootname$
  5. * 版 本 号 :  v1.0.0.0 
  6. * 说    明 :     
  7. * 作    者 :  $username$
  8. * 创建时间 :  $time$
  9. * 更新时间 :  $time$
  10. ************************************************************************
  11. * Copyright @ 灵雨工作室 $year$. All rights reserved.
  12. ************************************************************************/
  1. <pre class="csharp" name="code">using System;

  2. using System.Collections.Generic;  
  3. $if$ ($targetframeworkversion$ == 3.5)using System.Linq;  
  4. $endif$using System.Web;  
  5. using System.Web.UI;  
  6. using System.Web.UI.WebControls;  
  7. namespace $rootnamespace$

  8. {  
  9. public partial class $classname$ : System.Web.UI.Page  
  10. {  
  11. protected void Page_Load(object sender, EventArgs e)  
  12. {  
  13. }

  14. }  
  15. }  
  16. </pre>  
  17. <pre></pre>  
  18. <p><br>  
  19. 生成的文件:<br>  
  20. </p>  
  21. <pre class="csharp" name="code">/************************************************************************
  22. * 项目名称 :  工作日志系统  
  23. * 项目描述 :     
  24. * 类 名 称 :  Default2
  25. * 版 本 号 :  v1.0.0.0 
  26. * 说    明 :     
  27. * 作    者 :  灵雨飘零
  28. * 创建时间 :  2012-5-12 14:26:49
  29. * 更新时间 :  2012-5-12 14:26:49
  30. ************************************************************************
  31. * Copyright @ 灵雨工作室 2012. All rights reserved.
  32. ************************************************************************/
  33. using System;  
  34. using System.Collections.Generic;  
  35. using System.Linq;  
  36. using System.Web;  
  37. using System.Web.UI;  
  38. using System.Web.UI.WebControls;  
  39. public partial class Default2 : System.Web.UI.Page

  40. {  
  41. protected void Page_Load(object sender, EventArgs e)  
  42. {  
  43. }

  44. }  
  45. </pre>  
  46. <p> </p>  
  47. <p>修改其他的模板按照以上修改方法即可,此处不再详述。</p>  
  48. <p><br>  
  49. </p>
时间: 2024-10-14 06:34:42

让Visual Studio 自动添加头部注释信息的相关文章

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

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

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

以web项目为例: 一:给类加注释 1.在visual studio 的安装路径下 如:[盘符]:/Program files/Microsoft Visual Studio 8/Common7/IDE/ItemTemplates/web/cshare/2052/class.zip ,将里面的class.cs改为: C#代码  /*---------------------------------------------------------------- // Copyright (C) 2

[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 :

Sublime3 自动添加Python头部注释信息

1.新建一个插件(Tools --- Developer --- New Plugin)写入如下内容,并保存为 head.py import sublime, sublime_plugin import datetime class PyHeadCommand(sublime_plugin.TextCommand): def run(self, edit): self.view.run_command("insert_snippet", { "contents":&

[WinForm] - &quot;更新 DataSet 应用程序集对象失败,Visual Studio 自动重启&quot; 之解决

背景 在 WinForm 解决方案中,更新 DataSet 应用程序集对象失败,Visual Studio 自动重启. 试一试 1. 更新 .xsd 时打开对应的 .Designer.cs.2. 如果更新 TableB 失败,但是更新 TableA 没问题,试着同时更新AB两张表,TableB 可能被附带着更新成功.3. 失败了没关系,多试几次!

为Visual Studio 2012添加MSDN离线帮助

之前有网络的情况下,一直使用的都是在线的,最近又有笔记本上面有时使用时没有网络,所以就想使用下离线的MSDN包.可是找了半天,发现都是需要再次进行下载的.VS2012使用的帮助程序是HelpViewer2:(可直接打开HelpViewer或打开VS后--帮助--添加移除帮助内容) 于是自己使用联机进行了离线更新,下载了一些MSDN上的帮助文档.但在这个过程中,发现下载及其缓慢,首先声明我的网速下载其实很快的.感觉每次都这样下载岂不是很无语~~所以我就尝试着下载了大部分的MSDN文档(当然是晚上挂

Visual Studio 2010添加数据源时没有实体数据模型Entity Data Model选项

Visual Studio 2010添加数据源时没有实体数据模型Entity Data Model选项 今天在用VS2010创建控制台应用程序,添加数据源的时候,没有"实体数据模型"选项.在网上搜索了下,很多人都遇到了这个问题.我最后找到了解决方案. 在安装文件夹中找到WCU\EFTools文件夹,如果直接运行msi文件会报错:To install this product please run Install.exe.将里边cab和msi文件拷贝出来到E盘(便于操作),并创建Log.

Visual Studio Code 添加设置代码段(snippet)

从VSCode发布以来就在关注,最近已经更新到版本0.10.8,已经支持了插件功能.日常使用编辑器已经由Sublime Text迁移到了VSCode.使用中遇到了这个问题,在网上也没搜到解决方案.记录下自己摸索的方法.1.首先可以打开一个C#的文件(或在当前打开文件中)按快捷键Ctrl+Shift+P打开命令输入 snippet : (也可以点击File=>Preferences=>User Snippets)选择第二个选项Preferences:Snippets.(我这里有多个选项是由于我另

Visual Studio 2017 添加引用报错

最近安装了VS2017,在开发时需要添加引用,于是像原来使用vs2012那样直接右键,添加引用,结果弹出一个错误提示"未能完成操作.不支持此接口".真真是见了鬼了...... google.度娘一顿搜,结果根本就没有这个错误信息的任何消息,倒是有很多同样问题描述的案例,不过他们的提示都是"未能正确加载ReferenceManagerPackage包".因此估计跟我的是同一问题(不明白我的提示语怎会如此奇葩),遂按照解决方法试了一下 1.打开 Developer Co