扩大JDT实现自动代码注释与格局化[Java编程]

引言

源代码注释是对代码的注释和阐明.代码注释可以有效帮忙程序 员筹划未完成的代码任务,削减阅读和理解陈旧代码的时间本钱,帮助定位大概 产生错误的代码等,特别在开辟人员流动较大的情形下,代码注释的良莠直接关系到工作交代的履行效率乃至整个开辟周期的时间和质量掌握.清楚的代码编程标准和具体精确的代码注释已经成为评价软件源代码质量的重要参考尺度之一.

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实现自动代码注释与格局化[Java编程]”的内容，如果你对以上该文章内容感兴趣，你可以看看七道奇为您推荐以下文章：