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

核心提示： 图 1. Add Comment and Format 按钮下面通过一个实例来展示此工具的执行过程及效果，首先，扩展 JDT 实现自动代码注释与格式化(2)，重新配置首选项 Code Template的注释格式（参见 图 2），在本文示例中操作如下：在 Code->New Java Fil

图 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. 修改完模板前后代码比较

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

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