添加注释

        最近在重构的时候遇到问题，在网上进行查找，看到好多人的博客里代码都有类头注释，写着一些详细的信息。刚开始以为就是像行注释一样，自己手动添加的，然后每个类都来复制粘贴一下，后来一想机房那么多的类，这多麻烦呀，再说了有好几个地方都不一样呢，所以就动手查了查，原来是自己编写好的，然后在新建类时VS就能自动的为我们添加提前写好的类头注释。下面来看一下类头注释的步骤：

        一、找到Class.vb这个文件，以记事本的方式打开。（直接搜索即可找到；或是手动查找：找到VS的安装目录，依次进入vs\Common7\IDE\ItemTemplatesCache\VisualBasic\Code\2052\Class，便可找到Class.vb这个文件）          

    二、把相关的内容添加进去并保存即可。

     三、 以后建立新类的时候就会自动添加类头注释。

   

     下面是注释模板中的一些参数：

                                              

参数	描述
clrversion	当前系统CLR版本号
GUID [1-10]	生成全局唯一标识符,可以生成10个 (例如:guid1)
itemname	打开添加新建项时输入的文件名称
machinename	当前机器的名称(如:XXXX)
registeredorganization	注册的组织名，可以是小组名
rootnamespace	当前系统的根命名空间
safeitemname	保存的文件名，名称移除了不安全的字符和空格
time	当前系统时间,格式:DD/MM/YYYY 00:00:00.
userdomain	用户所在的域
username	当前系统用户名
year	当前系统年份 YYYY

     

       注意：我们这里是以Class为例写的类头注释，我们可以给其他的内容自行定义注释，大家尽情的尝试吧……

我们在重构中用到了很多的方法，所以摸索着又发现了对方法的注释：

        注释这个东东，我们在第一遍机房的时候，写过过程注释和行注释，重构的时候又添加了类头注释和方法注释，可见注释对我们走向专业化是很重要的呀！老师总是强调我们会是一个团队在工作，我们要时刻的为人民服务！