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

时间: 2024-11-08 05:42:43

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

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

vs中的///文档注释类似java中/** */文档注释.能自动的生成帮助文档. 如果我想在每次创建文件时,自动生成文档注释(注意是自动生成文档注释而不是帮助文档),如下面的代码,需要设置VS的模板,新创建的cs类文件会根据模板的样子进行生成.常用的VS文件模板有3个,分别是Class.zip.Interface.zip.From.zip. 我以Class.zip模板设置为例,模板在vs2010下的路径 C:\Program Files (x86)\Microsoft Visual Studio

mac 访达修改所有文件夹默认排序方式

先说个误区,下图只能改变当前目录的排序方式 修改所有目录的排序方式需要在顶部的“显示” 中修改 原文地址:https://www.cnblogs.com/andong2015/p/11357147.html

修改XCode默认注释并自动生成文档

1.找到注释模板位置 首先右键Xcode -> 选项 -> 在Finder中打开 -> 右键 -> 显示包内容 Contents/Developer/Platforms/iPhoneOS.platform/Developer/Library/Xcode/Templates/File Templates/Source/Cocoa Touch Class.xctemplate 2.修改模板文件 这个目录下面有很多后缀名为Objective-C跟Swift的文件夹 我们先随便打开一个UI

YAML 模板文件语法

YAML 模板文件语法 默认的模板文件是 docker-compose.yml,其中定义的每个服务都必须通过 image 指令指定镜像或 build 指令(需要 Dockerfile)来自动构建. 其它大部分指令都跟 docker run 中的类似. 如果使用 build 指令,在 Dockerfile 中设置的选项(例如:CMD, EXPOSE, VOLUME, ENV 等) 将会自动被获取,无需在 docker-compose.yml 中再次设置. image 指定为镜像名称或镜像 ID.如

整理 PHPstorm实用个人配置,修改调整个性化快捷键,修改使用phpstorm创建的模板的默认注释:

对你有助请点赞,请顶------送人玫瑰,手留余香! 1:58 2016/3/12 整理PHPstorm实用个人配置,修改调整个性化快捷键,修改使用phpstorm创建的模板的默认注释: PHPstorm配置:修改使用phpstorm创建的模板的默认注释 注意:我的也是phpstorm 10,但是配置的位置与下面参见的文章中描述的有所不同: 位置: 主要在一下两个路径: File | Settings | Appearance & Behavior | Appearance File | Set

修改使用phpstorm创建的模板的默认注释

修改使用phpstorm创建的模板的默认注释听语音 如下图中的Created by JetBrains PhpStorm.和最后一句都不是我想要的.所以需要稍微修改下,但是照他说的在File | Settings | File Templates.里修改,但是根本找不到这个路径,原来是在偏好设置里面. 1 先点击PhpStorm,选择"perfernces" 2 然后点击"File and Code Templates"就会看到各种模板啦. 3 比如我做了如下修改

pycharm 修改新建文件时的头部模板(默认为__author__=&#39;...&#39;)

pycharm 修改新建文件时的头部模板 默认为__author__='...'    [省略号是默认你的计算机名] 修改这个作者名的步骤: 依次点击:File->Settings->Editor->File and Code Templete 点击右侧Templates选项卡,会有一些格式文件新建时的模板 在这里可以修改这些默认模板 以修改Python Script为例: 默认为: __author__ = '$USER' 把 '$USER' 换成你想要的作者名,也可以直接将这一句删掉

VS模板文件修改,自动生成注释

VS的模板文件存放在IDE下的ItemTemplatesCache文件夹下 1.不同VS版本IDE文件夹路径个有不同,下面以VS2012为例,IDE文件夹路径如图: 2.打开IDE文件夹下的ItemTemplatesCache,如下图: 3.OK,开始修改.cs类文件的模板,找到模板所在位置:CSharp\Code\1033\Class\Class.cs,打开文件如图: 4.模板内容代码如下: /* ================================================

MFC 修改默认生成文件和默认生成工程内容

修改默认生成文件和默认生成工程的内容是非常非常实用的!因为这样我们就不用每次新建一个工程都去做以前做过的一些工作,譬如用到OpenCV就要去包含它的头文件等等,当然在.h文件中默认直接加上作者.公司的描述也会显得更方便,方法如下: 首先是修改.h和.cpp文件的默认生成内容(即添加新建项时文件将会自带你添加的内容,而不是空白一片),这个问题关键在于找到其模板文件路径,本人的路径是"C:\Program Files (x86)\Microsoft Visual Studio 12.0\VC\vcp