懒人懒法——VS自动添加类、函数注释、版权信息

为了别人能在使用自己的代码时能够看懂,注释是必不可少的。格式一般是固定的,像类、函数的注释，还有版权信息，作者是谁谁啦，时间是什么时候。但是比起一行一行的写注释，懒人更愿意有个方便的方法，能减少这样的工作量。

所以，像我这种懒人呢，就找了能让自己省事的方法。这次接触的是宏脚本。

 【VS宏脚本自动添加版权信息】

虽然我不怎么懂关于宏的东西，但从网上看到的VS2010的宏脚本是VBScript，比较容易懂，具体方法：

工具→宏→新建宏项目，输入文件名称，并选择要保存的位置

将下面的代码复制进去，保存。（vb的文件，注释符号用“ ' ”,c#或其他语言时改成相应的注释符号即可）

 

Imports System

Imports EnvDTE

Imports EnvDTE80

Imports EnvDTE90

Imports EnvDTE90a

Imports EnvDTE100

Imports System.Diagnostics

 

Public Module Module1

    Sub AddNew()

        Dim DocSel As EnvDTE.TextSelection

        DocSel = DTE.ActiveDocument.Selection

        DocSel.NewLine()

        DocSel.Text = " '***********************************************************************"

        DocSel.NewLine()

        DocSel.Text = " '版权所有：Coder_Yang"

        DocSel.NewLine()

        DocSel.Text = " '文件名称：" + DTE.ActiveDocument.Name

        DocSel.NewLine()

        DocSel.Text = " 'CLR 版本：" + DTE.Version

        DocSel.NewLine()

        DocSel.Text = " '描    述："

        DocSel.NewLine()

        DocSel.Text = " '作    者：Coder_Yang  "

        DocSel.NewLine()

        DocSel.Text = " '博    客："

        DocSel.NewLine()

        DocSel.Text = " '创建日期：" + System.DateTime.Now.ToString()

        DocSel.NewLine()

        DocSel.Text = " '修 改 人："

        DocSel.NewLine()

        DocSel.Text = " '修改日期："

        DocSel.NewLine()

        DocSel.Text = " '修改原因："

        DocSel.NewLine()

        DocSel.Text = "'***********************************************************************"

    End Sub

 End Module

【使用方法】

  工具→选项→环境→键盘

 

 

 

在显示命令包含输入框里输入你刚刚新建的文件名，

如上图，我输入了文件的前三个字母，就找到了刚刚保存的文件AddNew

 

接下来，设置用来运行宏的快捷键，注意不要和已有的快捷键相冲突。

将光标定位在“按快捷键（P）”对应的输入框处，接下来，在键盘上按你想设置的快捷键。比如我想设Alt+N为快捷键，就按键盘上的AIt和N键，你会发现，输入框自动出现了“Alt+N”，点分配，最后确定，完成！

如图，

 

 

下面让我们来验证一下效果吧

 

随便新建了一个vb.net文件

 

打开代码编辑界面，按下设置好的快捷键（Alt+N），看效果