vs 文档注释 文档注释模板设置

摘要:
vs中的//document注释与java中的/***/document注释类似。可以自动生成帮助文档。如果我想在每次创建文件时自动生成文档注释(注意,文档注释是自动生成的,而不是帮助文档),如以下代码所示,我需要设置VS模板,新创建的cs类文件将根据模板生成。使用系统;使用System.Collections。通用的使用系统。Linq;使用系统。文本纳

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

vs 文档注释 文档注释模板设置第1张

双击打开Class.zip直接编辑Class.cs,不用解压缩,编辑完保存。模板代码设置如下:

    /// <summary>
/// FileName: $safeitemrootname$.cs
/// CLRVersion: $clrversion$
/// Author: Ming
/// Corporation:
/// Description:
/// DateTime: $time$
/// </summary>
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 格式表示的当前时间。
 
userdomain
 当前的用户域。
 
username
 当前的用户名。
 
year
 以 YYYY 格式表示的当前年份。

保存并关闭,完成模板设置,会发现新创建的类文件如您所愿。

其他vs版本的设置步骤相同。在vs根目录下搜索Class.zip等模板文件的物理路径

vs 文档注释 文档注释模板设置第2张

ItemTemplates与ItemTemplatesCache的区别在于,如果您设置了ItemTemplates下的模板,需要在VS命令行中运行devenv /setup 命令  ,以Itemtemplates模板生成ItemTemplatesCache的模板,也就是说ItemTemplatesCache模板的设置会被原始的Itemtemplates模板还原。所以最好不要轻易改变Itemtemplates模板下的内容(他不能还原)。

Web下的Class.zip设置用于对web网站下的类文件起作用。

Ok说完了,累了,困了 休息。。。

免责声明:文章转载自《vs 文档注释 文档注释模板设置》仅用于学习参考。如对内容有疑问,请及时联系本站处理。

上篇Ubuntu中挂载NTFS分区并且正常显示中文目录和文件http 本地服务器设置任意IP访问对应的文件夹下篇

宿迁高防,2C2G15M,22元/月;香港BGP,2C5G5M,25元/月 雨云优惠码:MjYwNzM=

随便看看

【NS-3学习】ns3-模拟基础:关键概念,日志,命令行参数

前言本博客首先介绍了模拟过程中使用的一些关键概念,然后介绍了有助于调试模拟脚本的常见技术:日志、命令行参数。Ns-3不是一个特殊的互联网模拟器,而是一个网络模拟器。在ns-3的仿真环境中,节点可以连接到表示数据交换通道的对象。这里,基本通信子网的抽象概念被称为信道,由C++中的channel类描述。在ns-3中,网络设备的抽象概念相当于硬件设备和软件驱动程序...

VMware vSphere 7.0 安装教程

插入CD,启动系统并等待安装包加载映像,按Enter等待协议条款,同意,然后按F11进行磁盘分区管理。由于测试环境的原因,只有一个硬盘,直接按Enter键进入键盘布局,选择默认设置,按Enter键设置根帐户的密码,输入完成后按Enter键确认安装,按F11键等待安装完成,取出安装CD,重新启动后按Enter重新启动系统,正在加载到系统中…请确保已导入磁盘。错...

实用干货丨如何使用Prometheus配置自定义告警规则

前言普罗米修斯是一个用于监控和报警的开源系统。在普罗米修斯的术语中,它所监视的事物被称为目标。在本文中,我们将逐步展示如何安装Prometheus来监控/创建报警,并根据自定义事件配置自定义报警规则。当条件满足时,它将发出警报集成Alertmanager来处理客户端应用程序发送的警报。警报管理器将与发送警报通知的电子邮件帐户集成。了解普罗米修斯操作员根据普罗...

安装gulp教程(整理)

所以安装nodejs。...

如何设置Navicat的显示字体与字体大小?

方法/步骤打开Navicat点击菜单,再选择在界面,点击下的设置网格字体和大小设置编辑器字体和大小设置命令列界面字体和大小设置ER图表字体和大小,最后点击END...

Linux 安装.src.rpm源码包的方法

接下来是rpm安装过程。...