扩展JDT实现自动代码注释与格式化

引言

源代码注释是对代码的解释和说明。代码注释可以有效帮助程序 员规划未完成的代码任务，减少阅读和理解陈旧代码的时间成本，辅助定位可能 产生错误的代码等，尤其在开发人员流动较大的情况下，代码注释的良莠直接关系到工作交接的执行效率甚至整个开发周期的时间和质量控制。清晰的代码编程规范和详细准确的代码注释已经成为评估软件源代码质量的重要参考标准之一。

Eclipse 作为目前最优秀的 Java 集成开发环境之一，虽然提供了代码模板 用于定制代码和注释的格式，但它仅仅在第一次建立 Java 文件和自动插入代码 片段时才会按模板定制内容插入预定义的注释和代码片段，这相对于漫长的代码 维护过程是远远不够的。比如：需要为已经存在的所有源代码文件增加一份版权 声明的注释，Eclipse 提供的模版和格式化功能无法满足类似的需求。本文提供 的工具，正是为弥补 Eclipse 模版功能的不足，使 Java 代码及注释可以在任 何时候更新到最新的模版，极大简化维护代码注释与格式的工作量。

工具介绍

本文的解决方案是基于 Eclipse3.4 版本内置的 JDT（Java Development Tool）的基础设施开发一个插件项目 Add Comment and Format。 此插件按照 Eclipse 工作空间首选项中代码风格模板的设置为工作空间内的 Java 代码添加、修改注释并格式化 Java 源代码。

读者可下载此插件项 目，将其以已存在项目导入到 Eclipse 中，以“Run an Application”方式运行启动项，创建新的 Eclipse 应用程序。可以看到 新的 Eclipse 应用程序中出现 Add Comment and Format工具栏按钮（Action） （参见 图 1）。点击此按钮即可触发添加 Java 代码注释和格式化 Java 代码 事件。

图 1. Add Comment and Format 按钮

下面通过一个实例来展示此工具的执行过程及效果。

首先，重新配置首选项 Code Template的注释格式（参见 图 2）。在本文示 例中操作如下：在 Code->New Java File模板中添加 plug in development ，删除 ${filecomment}；在 Comments-> Fields模板中将 ${field_type}添 加到字段名前，在 Methods模板中删除 return。

图 2. Eclipse Code Template 首选项配置页面

然后，点击工具栏中 Add Comment and Format按钮（参见 图 1），执行格 式化代码及注释功能并查看结果（参见 图 3）。

图 3. 修改完模板前后代码比较

扩展JDT实现自动代码注释与格式化(2)

图 3为工作空间中某一 Java 文件执行 Add Comment and Format 插件前后 的对比图。图左为执行之前，Eclipse 工作空间中的代码与模版设定风格不一致 ，注释添加参差不齐，而且已有的注释内容也需要调整。右边为执行之后， Eclipse 按照模板的设定格式为 Java 文件添加、修改、删除注释并格式化，具 有良好的代码风格。

Add Comment and Format插件可以方便地更新工作空间内 Java 代码风格， 保持代码风格的一致与规范。它既没有改变原有代码的重要组成部分，也没有产 生冗余的代码注释，大大减少人工修改的工作量和出错率。

实现步骤：

实现 Add Comment and Format插件的功能主要包括如下步骤：

遍历 Eclipse 工作空间获取 Java 编译单元

从 eclipse 工作空间的资源中获得 Java 项目，并且遍历此项目以获得 Java 编译单元，即工作区内的 Java 源文件（.java）。

得到 Java 编辑单元的工作副本缓存

工作副本是对 Java 源代码进行修改时的缓存，可通过操作工作副本缓存来 修改代码。

修改代码

通过工作副本缓存修改代码，按照模板重新生成 Java 代码内容并替换原文 件，重新添加引用包列表，为 Java 代码中方法、字段添加或

凌众科技专业提供服务器租用、服务器托管、企业邮局、虚拟主机等服务，公司网站：http://www.lingzhong.cn 为了给广大客户了解更多的技术信息，本技术文章收集来源于网络,凌众科技尊重文章作者的版权，如果有涉及你的版权有必要删除你的文章，请和我们联系。以上信息与文章正文是不可分割的一部分,如果您要转载本文章,请保留以上信息，谢谢!