VS修改模板⽂件,增加默认注释
其实这篇⽂章是从⽹上转载的,但是不到转载链接,只能⾃⼰复制过来了
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
vs2010 Microsoft Visual Studio 10.0
vs2012 Microsoft Visual Studio 11.0
vs2015 Microsoft Visual Studio 14.0
这⾥和⽹上的说法有些不同,⽹上省了\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 }
/
/-----------------------------------------------------------------------------------
// <copyright file="$safeitemrootname$.cs" company="xx Enterprises">
// * copyright: (C) $year$ xx科技有限公司版权所有。
// * version : 1.0.0.0
// * author : $username$
// * fileName : $safeitemrootname$.cs
// * history : created by liuxiaoji $time$
// </copyright>
// <summary>
// $rootnamespace$.$safeitemrootname$
// </summary>
/
/-----------------------------------------------------------------------------------
using System;
using System.Collections.Generic;
$if$ ($targetframeworkversion$ >= 3.5)using System.Linq;
$endif$using System.Text;
$if$ ($targetframeworkversion$ >= 4.5)using System.Threading.Tasks;
$endif$
namespace $rootnamespace$
{
public class $safeitemrootname$
{
}
}
这⾥$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 格式表⽰的当前时间。
visual studio和vs code的区别userdomain 当前的⽤户域。
username 当前的⽤户名。
year 以 YYYY 格式表⽰的当前年份。
保存并关闭,完成模板设置,会发现新创建的类⽂件如您所愿。
其他vs版本的设置步骤相同。在vs根⽬录下搜索Class.zip等模板⽂件的物理路径
ItemTemplates与ItemTemplatesCache的区别在于,如果您设置了ItemTemplates下的模板,需要在VS命令⾏中运⾏devenv /setup 命令,以Itemtemplates模板⽣成ItemTemplatesCache的模板,也就是说ItemTemplatesCache模板的设置会被原始的Itemtemplates模板还原。所以最好不要轻易改变Itemtemplates模板下的内容(他不能还原)。
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论