敏捷开发之代码注释

最新推荐文章于 2021-11-24 06:54:02 发布

原创最新推荐文章于 2021-11-24 06:54:02 发布 · 523 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#敏捷开发 #工具 #javadoc #keyboard #module #tools

Develops 专栏收录该内容

6 篇文章

订阅专栏

时间长了了，有点憋得慌，所以忍不住要写点什么，也算是纪念刚过去的这场大雪吧，希望这场雪能够涤去甲流带给人们的恐慌，更希望雪灾严重地区的人们一切平安。

首先声明下，这里要介绍的小技巧可能勉强和持续构建挂点边，所以这个标题有点大，这一套完全是从标题党那里学来的，为的就是赚眼球，见笑了。

相信不少的同学们多少都要使用visual studio ，编码的过程中自然少不了写代码文档，用惯了eclipse 的同学可能会觉得studio 中写点注释太麻烦了，基本上所有的东西都要手动敲进去，没有一点自动化的快感，鉴于此，这里准备介绍一个如何使用studio 提供的宏来定制一款自动生成代码的工具，算是弥补一下studio 在这方面的缺陷。为便于说明，这里以自动生成函数注释为例进行说明。

首先，打开studio 后，选择Tools ----> Macros ----->macro explorer ，在打开的窗口中从右键菜单选择New Macro Project 新建一个工程，工程名权且叫做CommentsProject ，当然了，你也可以不喜欢这个名字，自己重新起个，下文中亦是如此。工程建完后，右击工程名，在此工程下新建个Module ，比如叫CommnentModule ；

接下来，对，you got it ，右击Module 名新建一个Macro ，在弹出的Project Explorer 中，将Macro 的名字改为CommnentBegin ，然后在为这个Macro 添加生成注释的代码，这里为了后期的文档生成，使用 javadoc 风格的注释，代码如下：

Sub CommnentBegin()
        Dim funSec As EnvDTE.TextSelection
        funSec = DTE.ActiveDocument.Selection
        funSec.NewLine()
        funSec.Text = "/**"
        funSec.NewLine()
        funSec.Text = "* @brief ： "
        funSec.NewLine()
        funSec.Text = "*"
        funSec.NewLine()
        funSec.Text = "* @para ： "
        funSec.NewLine()
        funSec.Text = "* @retv ： "
        funSec.NewLine()
        funSec.Text = "* @auth ： "
        funSec.NewLine()
        funSec.Text = "* @time ： " + System.DateTime.Now.ToLongDateString()
        funSec.NewLine()
        funSec.Text = "*/"
    End Sub

这样，一个自动生成注释的命令就定制完毕了。接下来，看看效果如何，将鼠标定位到Studio 的编辑框中想添加注释的位置，然后在Macro explorer 中右键选中创建的宏，选择Run ，这样注释有很大一部分就自动生成了。怎么样，写注释也就没有那么讨人厌了吧。其实写代码也和设计一样，也讲究封装变化，固定不变规律性的东西抽取出来交给计算机来做，最大限度的榨取计算机的生产力，也就是为自己最大限度的节约人的劳力，下面我们就再进一步的压榨下计算机。

大家发现了没有，如果要调用刚才定制的那个宏工具，还得用鼠标在Macro explorer 选中这个宏，然后右击，然后再点击run 命令，如果Macro explorer 窗口没有出现的话还得激活它，好不热闹。而且每次调用都要重复上面一套规定动作，是不是能简化下呢，答曰，然也。下面我们就采用快捷方式来调用这个工具

首先点击Tools --->Customize, 选择Command 页，然后点击左下角的Keyboard 按钮，在show commands containing 文本框中输入刚才所建宏的全名，或者也可以直接从文本框下面的滚动框中找到你所建立的宏名，找到后，点击Press short keys 文本框，然后在键盘上选择调用CommnentBegin 的快捷键，这里建议大家使用组合键，比如Alt+F ，同时按下Alt 和F 键后，文本框中就会出现Alt+F 字样，此时再点击文本框右边的Assign 按钮，这样你就可以通过快捷方式来调用这个代码注释自动生成的工具了。