头文件注释轻松搞—VS2013

       随着学习的不断深入，我们也正在逐步触摸到职业化的门槛，就拿注释来说，良好的注释说明在职业化编程中是非常必要的，因为这有助于他人对程序的阅读理解，使小组之间交流起来更加便利。

       这几天在编写重构机房收费系统，里面当然少不了注释，但是我对其中的一种注释却非常的头疼—文件头注释。因为头注释里面的内容多，而且每个类或窗体里面的头注释内容大多相似，所以每次新建一个类或窗体的时候都要复制粘贴（当然还得稍微修改一下）。每次做这些重复的事情让我感到很无奈，所以就想到是不是有种方法可以让VS自动生成头注释呢？在网上一搜索就查询到了很多关于头注释编辑的文章，果然有很多大牛们都想到了这种情况，并且还提供了解决的方法。

       在这里给大家做一个详细的说明：

头文件注释的要求：

       注释中必须添加的内容有：版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等，头文件的注释中还应有函数功能简要说明。

类头注释的模版：

 （仅供参考）

'**********************************************

' 文  件  名：$safeitemname$

' 命名空间：$rootnamespace$

' 内       容：

' 功       能：

' 文件关系：

' 作       者：XXX

' 小       组：XX

' 生成日期：$time$

' 版  本  号：V1.0.0.0

' 修改日志：

' 版权说明：

'**********************************************

如何添加模版：

（以我为例）

1. 打开VS2013的安装目录  D:\应用软件\Visual Studio 2013

2. 找到Common7文件夹，接着打开 Common7\IDE\ItemTemplatesCache

3. 在这里我们会看到VisualBasic文件夹，依次打开 VisualBasic\Code\2052\Class ，找到Class.vb文件并且以记事本方式打开，在其中加入以上的模版保存，如下图：

                

然后打开VS2013，新建一个类试一下效果：果然，新建类时VS就会自动生成 头文件注释了。

         

  4. 在VisualBasic\Code\2052这个目录下还有Interface ，WebClass 等文件夹，没错修改其中相应的.vb文件，添加上述模版，效果图：接口的头注释已经自动添加。

          、

      5.现阶段大家做的系统有很多From窗体，可是在VisualBasic\WindowsForms\2052里并没有From这个文件夹，那么From的注释模版该怎么添加呢？

打开步骤三中的文件夹VisualBasic，找到\VisualBasic\WindowsForms\2052\Form，找到From.vb文件并按照上述方法修改即可。

 

    另外：在D:\应用软件\VisualStudio 2013\Common7\IDE\ItemTemplatesCache目录下不仅仅有VisualBasic，还有CSharp、JavaScript等语言，上述方法同样适用！

 

$safeitemname$、$rootnamespace$ ？？

    这些参数都是系统变量，功能类似于Foxmail模版里面的宏。

    其他可用的参数有：（需要注意：这些参数区分大小写！）

 

 

磨刀不误砍柴工，这些积累将来都会是我们提高工作效率的筹码！