源代码注释增强工具使用指南

在软件开发过程中,注释是代码的重要组成部分,它帮助开发者理解代码的功能和逻辑。Active Comments是一个为Visual Studio设计的插件,它通过提供额外的注释功能来增强源代码的可读性和维护性。本文将详细介绍如何安装和使用这个工具。

插件概述

Active Comments插件允许开发者在源代码中添加具有交互性的注释。这些注释可以链接到外部文件、电子邮件地址、互联网站点、MSDN文章,甚至可以插入语音评论。如果在使用过程中发现任何错误或问题,开发者可以通过反馈来帮助改进这个插件。需要注意的是,这个软件是“按原样”提供的,不包含任何形式的保证,如果它对系统造成了任何不良影响,请不要责怪开发者。

安装步骤

要安装Active Comments插件,请按照以下步骤操作:

  1. 将"ActiveComments.dll"文件复制到Developer Studio的插件目录下:
  2. C:\Program Files\DevStudio\MicrosoftVisual Studio\Common\MSDev98\AddIns
  3. 在Developer Studio中,转到"工具"菜单,然后选择"自定义..."。
  4. 转到"插件和宏文件"标签页(最后一个)。勾选"Active Comments"复选框,然后点击"关闭"。

Developer Studio将添加一个新的工具栏,包含以下按钮:

按钮标题 描述
Comment Setup 用于创建新的或修改现有的活动注释
View Commentary 执行与选定注释参考链接
List of all Active Comments 显示当前项目中所有活动注释的列表
Active comment clear 删除选定的活动注释,但保留文本中的标题
Delete Active Comment 完全删除选定的活动注释(包括文本中的标题)
Code Templates 插入从列表中选择的代码模板
Options Active Comment AddIn选项:清除历史列表,管理代码模板列表

如何使用

要使用Active Comments插件,请按照以下步骤操作:

  1. 将光标移动到想要插入活动注释的行,或选择想要创建活动注释的文本。
  2. 点击"Comment Setup"按钮,在弹出的对话框中输入注释标题(它将在源代码中显示)。指向文件(或MSDN文章、网页、电子邮件等)的引用。如果想要制作语音评论,请点击"显示录音控制"按钮,进行录音并保存(波形文件的名称将自动生成)。点击"确定"。

活动注释将显示出来。例如:

// [[->链接到MSDN]]

如果想要管理项目中的所有活动注释,选择"查看所有注释"命令。在随后的对话框中,可以编辑、删除和执行活动注释。

致谢

特别感谢Nikolay Egipco对本插件的贡献。

以下是Active Comments插件的一些历史版本更新:

增加了对"MS-ITS"协议的支持:这是微软的新协议(从IE 4.0开始支持),用于处理chm文件。更多信息请参见MSDN。

ChangeCase函数被移动到单独的插件Active Tools中。

在选项对话框的UtilitesPage中添加了新项:

  • 启用VC编辑器换行:打开/关闭Visual C++编辑器窗口的换行;
  • 启用双击注释:打开/关闭在活动注释上的鼠标双击跟踪;
  • 启用模板对话框重新定位:打开/关闭模板对话框重新定位。

修复了一些较小的错误。

在Active Comment(在DevStudio的SourceEditor中)上添加了处理事件LeftButtonDblClick的处理器:在DblClick之后,将执行链接的文件或播放语音评论或运行MSDN。

活动注释的定义方法得到了改进:现在可以在一行字符串中有多个acomments。

添加代码模板的功能也得到了改进:现在AddTemplateDialog会出现在光标所在位置附近(快捷键:Ctrl+Alt+J)。

插入代码模板的功能得到了修正:现在在代码模板中找到的"%s"字符将被选中的文本替换。

修正了执行注释链接到MSDN的功能。

增加了导入/导出代码模板的功能。

修复了一些较小的错误。

增加了基于属性页的选项对话框。它有以下页面:

  • 编辑模板页面 - 用于添加/编辑/删除代码模板;
  • 选项页面 - 目前只有一个选项:清除历史列表。

修复了以下条件下的错误:

  • 有一个注释,链接到一个网站,例如;
  • 然后将这个链接更改为文件链接,并且协议从变为;但是协议没有变化。

现在它工作正常。

历史列表限制为20条记录。

在CommentSetupDlg中增加了链接历史。

增加了版本控制。

增加了代码模板。

当添加一个新的活动注释时,选定的字符串会被检查以找到注释块。

沪ICP备2024098111号-1
上海秋旦网络科技中心:上海市奉贤区金大公路8218号1幢 联系电话:17898875485