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

核心提示：引言源代码注释是对代码的解释和说明，代码注释可以有效帮助程序员规划未完成的代码任务，扩展 JDT 实现自动代码注释与格式化，减少阅读和理解陈旧代码的时间成本，辅助定位可能产生错误的代码等，创建新的 Eclipse 应用程序，可以看到新的 Eclipse 应用程序中出现 Add Comment and Format工具栏

引言

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

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 代码事件。