机房收费系统总结之1——类头注释模板
最近一直在使用VS写程序,按编程规范都得写类头注释。有人说,这还不简单,写好一个类头注释,然后复制粘贴不就OK了吗。那你真的OUT了!“不怕不知道,就怕不知道”。其实在新建类时VS能自动为我们添加提前定义好的注释。步骤如何?下面就让我们来一步步见证奇迹(以VB.NET为例)。
步骤:
一、找到Class.vb这个文件,以记事本方式打开。(直接搜索即可找到;或是手动查找:找到VS的安装目录,依次进入ItemTemplatesCache\VisualBasic\Code\2052\Class,便可找到Class.vb这个文件)
二、把相应内容添加进去即可,并保存。如:
注意:
一、其他类型的注释也可自行定义。我们是以“Class”,也就是以类为基础的进行介绍的。但其他的内容也可自行定义注释模板,如“Web类库”或“接口”等(Web的在WebClass下面的Class.vb中,接口在Interface文件夹里)。当然其他VS中集成的开发语言(如C#)也都可自行定义。
二、参数设置
这里$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 | 以系统的格式添加的表示当前时间(日期+时间) |
userdomain | 当前的用户域 |
username | 当前的用户名 |
year | 以 YYYY 格式表示的当前年份 |