本帖最后由 李辰东 于 2012-10-12 16:31 编辑
不知道你想要的是不是這個
下文為轉載
vs中的///文档注释类似java中/** */文档注释。能自动的生成帮助文档。
如果我想在每次创建文件时,自动生成文档注释(注意是自动生成文档注释而不是帮助文档),如下面的代码,需要设置VS的模板,新创建的cs类文件会根据模板的样子进行生成。
查看源代码
打印
帮助
01 using System;
02 using System.Collections.Generic;
03 using System.Linq;
04 using System.Text;
05
06 namespace MODEL
07 {
08 ///
09 /// FileName: Class1.cs
10 /// CLRVersion: 2.0.50727.3053
11 /// Author: Ming
12 /// Corporation:
13 /// Description:
14 /// DateTime: 2011-7-23 21:32:54
15 ///
16 class Class1
17 {
18 }
19 }
常用的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,不用解压缩,编辑完保存。模板代码设置如下:
查看源代码
打印
帮助
01 /// <summary>
02 /// FileName: $safeitemrootname$.cs
03 /// CLRVersion: $clrversion$
04 /// Author: Ming
05 /// Corporation:
06 /// Description:
07 /// DateTime: $time$
08 /// </summary>
09 class $safeitemrootname$
10 {
11 }
这里$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模板下的内容(他不能还原)。
|