VS脚本添加注释模板

2008-09-20

现在的IDE越做越强大，为我等懒人省了不少。为了使用将来的代码自己或别人能看懂，注释这种东西必不可少。当为函数添加注释时，格式是固定的。每个函数写一遍，或从别的函数处拷贝过来，即麻烦又容易出错。这种重复劳动让人心烦都有不想写注释的欲望了，这时VS的宏可以干掉这些“脏、乱、累”的体力活。

看了一下，VS2005的宏脚本就是VBScript，很容易上手。我写了一个生成函数注释模板的宏脚本

'为函数自动添加注释
    'Script By Lonkil www.vcfans.com
    Sub AddFunComment()
        Dim DocSel As EnvDTE.TextSelection
        DocSel = DTE.ActiveDocument.Selection
        DocSel.NewLine()
        DocSel.Text = "/*******************************************************************"
        DocSel.NewLine()
        DocSel.Text = "* 函数名称： "
        DocSel.NewLine()
        DocSel.Text = "* 功    能： "
        DocSel.NewLine()
        DocSel.Text = "* 参    数： "
        DocSel.NewLine()
        DocSel.Text = "* 返 回 值： "
        DocSel.NewLine()
        DocSel.Text = "* 作    者： Lonkil"
        DocSel.NewLine()
        DocSel.Text = "* 电子邮箱： lonkil{AT}gmail.com ( {AT} -> @ )"
        DocSel.NewLine()
        DocSel.Text = "* 创建日期： " + System.DateTime.Now.ToLongDateString()
        DocSel.NewLine()
        DocSel.Text = "*******************************************************************/"
    End Sub

具体的创建步骤：VS2005 IDE -> 工具 -> 宏 -> 新建宏项目，选择要保存的位置。然后将要上面的脚本复制进去，保存即可。

具体的使用：为你编写的宏绑定快捷键，VS2005 IDE -> 工具 -> 选项 -> 在左边列表中选择“键盘” -> 在右边的“显示命令包含”中，选择你创建宏-> 将光标定位到”按快捷键”处 -> 输入你想命名的快捷键，比如”Alt+C”，保存即可。