Visual Studio 2010利用宏添加注释

在Visual Studio 2010（下面简称VS）编写类的过程中通常会在类的前面写上如下注释：

'------------------------------------------------------------------------------
' <copyright file="***.vb" company="YONG">
'     Copyright (c) 2011 YONG. All rights reserved.
' <copyright>
' <author>郗晓勇<author>
' <author>博客地址http://blog.csdn.net/beijiguangyong<author>
' <date>2011年4月29日<date>
' <description>
'
'
'
'
' <description>
'------------------------------------------------------------------------------

每次复制粘贴未免太麻烦，我们可以利用VS的宏来为我们自动添加如上注释。具体操作如下：

1.   找到VS的IDE宏编辑器

2.   打开后选择添加Model

3.   起一个自己喜欢的名字（这里以HeadFileNote为例）

4.   点击添加后出现如下编辑界面

 

5.   在右侧即可编辑自己所需要的“宏”了，我们将添加的“宏”代码如下

Imports System
Imports EnvDTE
Imports EnvDTE80
Imports EnvDTE90
Imports EnvDTE90a
Imports EnvDTE100
Imports System.Diagnostics

Public Module HeadFileNote
    Sub DocumentFileHeader()
        Dim doc As Document
        Dim docName As String
        Dim companyName As String = "YONG"
        Dim authorName As String = "郗晓勇"
        Dim authorContact As String = "我的博客地址http://blog.csdn.net/beijiguangyong"
        Dim copyrightText As String = String.Format("Copyright (c) {0} {1}. All rights reserved.", Date.Now.Year, companyName)

        ' 从程序中获得文件的名字
        doc = DTE.ActiveDocument

        '获得当前编辑类的名字
        docName = doc.Name

        ' 将添加焦点定位在文件首部
        DTE.ActiveDocument.Selection.StartOfDocument()

        ' 添加一个版权说明
        DTE.ActiveDocument.Selection.Text = "'------------------------------------------------------------------------------" '以String类型添加自己想要的符号、文字
        DTE.ActiveDocument.Selection.NewLine() '添加一个空行
        DTE.ActiveDocument.Selection.Text = "' <copyright file=""" + docName + """ company=""" + companyName + """>"
        DTE.ActiveDocument.Selection.NewLine()
        DTE.ActiveDocument.Selection.Text = "'     " + copyrightText
        DTE.ActiveDocument.Selection.NewLine()
        DTE.ActiveDocument.Selection.Text = "' <copyright>"

        ' 添加用户相关信息
        DTE.ActiveDocument.Selection.NewLine()
        DTE.ActiveDocument.Selection.Text = "' <author>" + authorName + "<author>"
        DTE.ActiveDocument.Selection.NewLine()
        DTE.ActiveDocument.Selection.Text = "' <author>" + authorContact + "</author>"
        DTE.ActiveDocument.Selection.NewLine()
        DTE.ActiveDocument.Selection.Text = "' <date>" + String.Format("{0:D}", Date.Now) + "<date>"
        DTE.ActiveDocument.Selection.NewLine()
        DTE.ActiveDocument.Selection.Text = "' <description>"
        DTE.ActiveDocument.Selection.NewLine()
        DTE.ActiveDocument.Selection.Text = "'"
        DTE.ActiveDocument.Selection.NewLine()
        DTE.ActiveDocument.Selection.Text = "'"
        DTE.ActiveDocument.Selection.NewLine()
        DTE.ActiveDocument.Selection.Text = "'"
        DTE.ActiveDocument.Selection.NewLine()
        DTE.ActiveDocument.Selection.Text = "'"
        DTE.ActiveDocument.Selection.NewLine()
        DTE.ActiveDocument.Selection.Text = "' <description>"
        DTE.ActiveDocument.Selection.NewLine()
        DTE.ActiveDocument.Selection.Text = "'------------------------------------------------------------------------------"
        DTE.ActiveDocument.Selection.NewLine()
    End Sub
End Module

6.   添加完毕后点击保存

这样我们的“宏”就编好了，下面接着介绍怎样定义快捷键为我们的类添加头注释。

7.   进入我们的VS开发环境打开选项，进行相关设置

8.   设置完成后单击“Assign”（注册快捷键）如图

9.   单击“OK”完成所有设置，现在就去按下快捷键试试自己编辑的“注释添加宏”吧。