VS2010 修改模板文件,增加默认注释

其实这篇文章是从网上转载的,但是找不到转载链接，只能自己复制过来了

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模板下的内容（他不能还原）。

转载于:https://www.cnblogs.com/zaspx/archive/2012/06/15/2550637.html

VS2010 修改模板文件,增加默认注释相关推荐

修改模板文件后，Build Project(ctrl+F9)可以快速运行
修改模板文件后,Build Project(ctrl+F9)可以快速运行
1.修改打开文件的默认方式/应用
水文,旨在记录自己遇到的问题,帮助使用win10遇到问题的小伙伴打开系统,选择框选内容 - [应用] 依次选择框选内容 - [默认应用] - [按文件类型指定默认应用] 找到特定文件,修改我们需要的 ...
如何在Windows10系统中修改.jar文件的默认应用
普通方式(无效) 通常,我们在Windows10系统中修改文件的默认应用有两种方式: 打开系统设置->应用->默认应用->按文件类型指定默认应用,找到相应的文件类型后进行修改: 选中 ...
VS2022修改模板文件
不管任何版本的vs,模板文件路径都是下面这两个 1033代表英文版 2052代表中文版 D:\Program Files\Microsoft Visual Studio\2022\Enterprise ...
codeblocks下如何修改新建文件的默认代码？
进入codeblocks的安装目录, 进入\share\CodeBlocks\templates\wizard\console\cpp, 修改main.cpp文件为你想要的模板.
修改微信文件的默认保存位置
大多数用户都是默认安装微信的,微信的安装目录.文件目录.聊天记录都默认的保存在C盘(系统盘中),当存储的聊天记录很多的时候,就会导致C盘(系统盘中)爆红,其它程序因为空间不足的原因无法启动,下面就根据 ...
修改Office文件的默认打开方式（含C#代码）
方法一新建或找到一个Word文件右键单击这个文件选择属性点击"打开方式"后面的"更改"按钮在"推荐的程序"或"其他程序& ...
java文件默认打开方式_修改文件的默认打开方式（亲测有效）
今天遇到了一个问题,那就是没办法修改文件的默认打开方式,Windos10系统. 可能我稍微有点强迫症什么的,每次默认记事本打开,虽然也可也选择其他的应用打开,但就是没有直接双击打开的爽. 一百度才发现 ...
自建html网页,幽灵自建的html5 的模板文件！
*{ font-family:Source Code Pro,Microsoft YaHei; padding:0; margin:0; } .main{ width: 80%; height: 45 ...

VS2010 修改模板文件,增加默认注释

VS2010 修改模板文件,增加默认注释相关推荐

最新文章

热门文章