`
灵雨飘零
  • 浏览: 34980 次
  • 性别: Icon_minigender_1
  • 来自: 唐山
文章分类
社区版块
存档分类
最新评论

让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会看到如下内容。

using System;
using System.Collections.Generic;
$if$ ($targetframeworkversion$ == 3.5)using System.Linq;
$endif$using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;

namespace $rootnamespace$
{
	public partial class $classname$ : System.Web.UI.Page
	{
		protected void Page_Load(object sender, EventArgs e)
		{

		}
	}
}

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

time$ 日期

$year$ 年份

$clrversion$ CLR版本

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

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

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

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

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

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

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

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

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

$userdomain$ 当前的用户域。

$username$ 当前的用户名。


我的一个注释示例:

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

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

/************************************************************************
 * 项目名称 :  $rootnamespace$  
 * 项目描述 :     
 * 类 名 称 :  $safeitemrootname$
 * 版 本 号 :  v1.0.0.0 
 * 说    明 :     
 * 作    者 :  $username$
 * 创建时间 :  $time$
 * 更新时间 :  $time$
************************************************************************
 * Copyright @ 灵雨工作室 $year$. All rights reserved.
************************************************************************/

using System;
using System.Collections.Generic;
$if$ ($targetframeworkversion$ == 3.5)using System.Linq;
$endif$using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;

namespace $rootnamespace$
{
	public partial class $classname$ : System.Web.UI.Page
	{
		protected void Page_Load(object sender, EventArgs e)
		{

		}
	}
}


生成的文件:

/************************************************************************
 * 项目名称 :  工作日志系统  
 * 项目描述 :     
 * 类 名 称 :  Default2
 * 版 本 号 :  v1.0.0.0 
 * 说    明 :     
 * 作    者 :  灵雨飘零
 * 创建时间 :  2012-5-12 14:26:49
 * 更新时间 :  2012-5-12 14:26:49
************************************************************************
 * Copyright @ 灵雨工作室 2012. All rights reserved.
************************************************************************/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;

public partial class Default2 : System.Web.UI.Page
{
    protected void Page_Load(object sender, EventArgs e)
    {

    }
}

修改其他的模板按照以上修改方法即可,此处不再详述。


分享到:
评论

相关推荐

    Visual_Studio_2010_常用快捷键(自动注释,自动排版)

    ### Visual Studio 2010 常用快捷键详解:自动注释与自动排版 #### 一、概述 Visual Studio 2010 是一款由微软开发的强大集成开发环境(IDE),支持多种编程语言如 C#, VB.NET, F# 和其他 .NET Framework 相关的...

    vs2012添加文件自动注释1

    完成上述步骤后,在Visual Studio 2012中新建类或接口文件时,IDE将自动添加上版权信息等注释。例如: ```csharp /************************************************************************************ * ...

    VS注释管理插件

    这个插件的核心功能在于自动化处理CS(C#)文件的头部注释,确保每个文件都有统一且完整的版权声明、作者信息、创建日期等。这不仅方便了个人项目的版权保护,也为团队协作时保持代码一致性提供了便利。通过自动添加...

    class 自动添加版权信息

    3. **集成开发环境插件**:对于特定的开发环境,如Visual Studio或Eclipse,可以开发插件,自动在代码文件头部添加版权注释。 4. **自定义应用程序**:如果需求复杂,可以开发一个独立的应用程序,提供图形用户界面...

    VSCode中自动为Python文件添加头部注释

    在使用Visual Studio Code (VSCode) 进行Python开发时,自动添加头部注释能够显著提高工作效率,确保每个文件的一致性和专业性。这个功能通过VSCode的自定义片段(Snippets)机制实现,让我们来详细了解一下这个过程...

    代码注释规范

    1. **文件头部注释**:在每个头文件的顶部加入一个标准的代码说明块,包括文件名、作者、修改记录、版本号、简介、修改日期等信息。此块可通过Visual Assist X的脚本功能快速插入。设置方法为: - 在“选项”->...

    Vs C#带文件信息的类模板

    总结来说,这个资源是一个用于Visual Studio的C#类模板,包含文件头部的注释结构和一些常用模板变量,以帮助开发者快速创建符合规范的类文件。通过理解和使用这些模板变量,我们可以创建具有个性化注释且易于维护的...

    C# 源文件头管理插件 for VS2008/2005

    标题中的"C# 源文件头管理插件 for VS2008/2005"指的是一个专门针对Visual Studio 2008和2005开发的扩展工具,其核心功能是帮助C#开发者管理和维护源代码文件的头部信息。在软件开发中,文件头通常包含关于文件的元...

    自动根据模板插入header、body内容插件

    标题中的“自动根据模板插入header、body内容插件”指的是一个用于Visual Studio Code(VSC)的扩展插件,它的主要功能是自动化地在代码文件中插入预定义的header和body部分。这样的插件对于软件开发团队尤其有用,...

    JSP动态网站开发实践教程(第2版)课件

    JSP注释是开发者用来在源代码中添加解释或调试信息的,它们不会被发送到客户端浏览器。JSP提供了两种注释方式:标准的HTML注释(<!-- -->)和Java注释(//单行注释,/*...*/多行注释)。 脚本元素包括表达式、脚本...

    Studio快捷键大全

    在编程和开发环境中,Visual Studio 是一款非常强大的集成开发环境(IDE),它的高效性部分得益于其丰富的快捷键功能。快捷键能够大大提高开发人员的工作效率,减少鼠标操作,使得程序员可以更加专注于代码编写。...

    C#贪吃蛇游戏 Windows窗体

    【C#贪吃蛇游戏 Windows窗体】是一个适合初学者的编程项目,它利用Microsoft的Visual Studio 2019开发环境,通过Windows窗体应用程序(Windows Forms Application)实现了一个经典的游戏——贪吃蛇。这个项目的核心...

    《Visual C++程序开发案例解析》 图像处理案例

    使用Visual Studio等IDE可以方便地调试和运行代码,同时理解编译器错误和警告信息对于解决问题至关重要。 通过这个案例,开发者不仅能够掌握C++编程的基础,还能深入理解图像处理的基本原理和技术,为今后在游戏...

    Asp.Net十大技巧,和大家分享下!

    Visual Studio.NET提供了方便的注释工具,通过快捷键`Ctrl+K+C`可以快速添加注释,而`Ctrl+K+U`则用于取消注释。对于C#代码,建议使用`///`开头的XML文档注释,它可以生成详细的文档信息,包括参数、返回值等细节,...

    Div+CSS布局入门教程(一二三四)

    - 在标签中添加Div结构,为每个部分创建对应的Div标签,并添加注释,便于后续阅读和修改。 - 编写CSS文件,定义各个Div的样式。例如: - body:设置字体、边距和背景色。 - #container:设置宽度为100%,确保Div...

    软件开发代码规范(C#版)

    - 文件头部注释:每个源文件应有简短的描述,包括作者、创建日期、版权信息等。 - 类注释:描述类的功能、用途以及与其他类的关系。 - 方法注释:解释方法的作用、参数及返回值,如有异常情况也需注明。 - 行内...

    .net编码规范.doc

    - **Visual Studio注释**:支持单行、多行和文档注释,用于解释代码功能和用途。 - **注释要求**:注释应简洁、准确,对于类、方法和关键代码块进行说明。 4. **编码** - **不建议使用的结构**:避免使用`do......

    实验三18084124杨振宇1

    实验环境为Visual Studio Code。 DICOM是一种标准格式,广泛用于医疗影像数据交换。实验内容分为四个步骤: 1. 使用open函数读取DICOM文件。这是程序读取文件的基础操作,通常涉及文件打开、关闭和错误处理。 2. ...

    DotNet编程规范

    - 使用Visual Studio提供的大纲显示功能,有助于扩展或折叠代码块。 - 代码块之间、变量声明后应添加空行,增强代码的可读性。 - 循环和分支的嵌套层次不宜过多,推荐不超过五层。 - 禁止在一行中编写多条语句,...

Global site tag (gtag.js) - Google Analytics