vs⽂档注释⽂档注释模板设置
vs中的///⽂档注释类似java中/** */⽂档注释。能⾃动的⽣成帮助⽂档。
如果我想在每次创建⽂件时,⾃动⽣成⽂档注释(注意是⾃动⽣成⽂档注释⽽不是帮助⽂档),如下⾯的代码,需要设置VS的模板,新创建的cs类⽂件会根据模板的样⼦进⾏⽣成。
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
namespace MODEL
{
///<summary>
/// FileName: Class1.cs
/// CLRVersion: 2.0.50727.3053
/// Author: Ming
/// Corporation:
/// Description:
/// DateTime: 2011-7-23 21:32:54
///</summary>
class Class1
{
}
}
常⽤的VS⽂件模板有3个,分别是Class.zip、Interface.zip、From.zip.
我以Class.zip模板设置为例,模板在vs2008下的路径
D:\Program Files\Microsoft Visual Studio 9.0\Common7\IDE\ItemTemplatesCache\CSharp\Code\2052
双击打开Class.zip直接编辑Class.cs,不⽤解压缩,编辑完保存。模板代码设置如下:
///<summary>
/// FileName: $safeitemrootname$.cs
/// CLRVersion: $clrversion$
/// Author: Ming
/// Corporation:
/// Description:
/// DateTime: $time$
///</summary>
class $safeitemrootname$
visual studio和vs code的区别{
}
这⾥$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模板下的内容(他不能还原)。
Web下的Class.zip设置⽤于对web⽹站下的类⽂件起作⽤。
Ok说完了,累了,困了休息。。。
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论