VS2010 修改模板文件,增加默认注释
http://www.cnblogs.com/zaspx/archive/2012/06/15/2550637.html
vs中的///文档注释类似java中/** */文档注释。能自动的生成帮助文档。
如果我想在每次创建文件时,自动生成文档注释(注意是自动生成文档注释而不是帮助文档),如下面的代码,需要设置VS的模板,新创建的cs类文件会根据模板的样子进行生成。常用的VS文件模板有3个,分别是Class.zip、Interface.zip、From.zip.
我以Class.zip模板设置为例,模板在vs2010下的路径
C:\Program Files (x86)\Microsoft Visual Studio 10.0\Common7\IDE\ItemTemplatesCache\CSharp\Code\2052\Class.zip
这里和网上的说法有些不同,网上省了\Code\目录,也许vs2008没有这个目录。
双击打开Class.zip直接编辑Class.cs,不用解压缩,编辑完保存。模板代码设置如下:
1 /* ============================================================================== 2 * 功能描述:$safeitemrootname$ 3 * 创 建 者:$username$ 4 * 创建日期:$time$ 5 * ==============================================================================*/ 6 using System; 7 using System.Collections.Generic; 8 $if$ ($targetframeworkversion$ >= 3.5)using System.Linq; 9 $endif$using System.Text; 10 11 namespace $rootnamespace$ 12 { 13 /// <summary> 14 /// $safeitemrootname$ 15 /// </summary> 16 public class $safeitemrootname$ 17 { 18 } 19 }
这里$var$ 都是系统的变量,模板参数是要区分大小写的,大家需要注意。系统提供的可用的参数如下:
参数 说明 clrversion 公共语言运行库 (CLR) 的当前版本。
GUID [1-10] 用于替换项目文件中的项目 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 当前的用户名。
year 以 YYYY 格式表示的当前年份。
保存并关闭,完成模板设置,会发现新创建的类文件如您所愿。
其他vs版本的设置步骤相同。在vs根目录下搜索Class.zip等模板文件的物理路径
ItemTemplates与ItemTemplatesCache的区别在于,如果您设置了ItemTemplates下的模板,需要在VS命令行中运行devenv /setup 命令 ,以Itemtemplates模板生成ItemTemplatesCache的模板,也就是说ItemTemplatesCache模板的设置会被原始的Itemtemplates模板还原。所以最好不要轻易改变Itemtemplates模板下的内容(他不能还原)。
关于VS2010在使用过程中的一些便捷之处
1、代码的折叠和展开:
在VS2010使用过程中,用#region/#endregion块来分区代码是一个经常被使用到的功能,可以使代码结构看起来更加清晰。
使用过程中有一些快捷键:
光标位于#region/#endregion包含的区域时,直接按Ctrl+m,m 可以使该语句块折叠/展开。
在代码中使用Ctrl+m,o 可以使整个文件的代码全部折叠起来。Ctrl+m,l (是L的小写)可以使整个文件的代码全部展开。
2、关于多行代码注释、取消的一种便捷方式:
使用传统的注释方式注释多行代码
/*
...(your code)
*/
每次注释或者取消注释的时候,需要将注释的语句块的两端一起修改。而下面这种方式可以只修改一出即可,非常有利于多行代码的注释、取消:
/*
...(your code)
/**/
使用这种方式可以将其中包含的多行代码注释,需要将该段注释取消的时候,只需要在最上面一行添加一个"/"即可:
//*
...(your code)
/**/