Java编程规范实践

一个好的编程规范可以让代码易于理解,具体的操作却不必如此麻烦。

本文包含以下内容:

Java代码Formatter配置

在Eclipse中可以通过Code Format和Code Template配置方便地实现代码格式化和注释定制。

  1. 首先选择了一款喜欢的编码格式:Nutz Java 编码规范 (V1.0)
  2. 阅读完毕后,找到对应的eclipse code format配置:nutz-eclipse-java-code-format-1.0.xml
  3. 接着就简单了,进入 Window->Preference->Java->Code Style->Formatter,导入xml,Apply,OK
  4. 在编写Java代码时,可以CTRL+SHIFT+F,即可完成格式化代码
  5. 批量格式化,选中项目或Package右键,选择Source->Format

代码模板配置

修改默认注释,导入新注释也很简单。进入 Window->Preference->Java->Code Templates

  1. 在Comments下可以修改默认的注释:比如函数注释,文件注释,作者签名等等
  2. 也可以导入配置好的注释或代码模板xml:比如nutz-eclipse-java-codetemplates.xml

代码格式和模板可以方便地导出为xml文件进行分享,用版本控制工具进行管理也很方便。

为不同的项目配置不同的格式怎么办?也很简单,可以在Preference中将配置改为基于项目即可。

配置完毕后,可以在编辑Java时使用Content Assist快捷键提示代码模板:

比如默认windows下配置的是"Alt+/",当然也可以自己设置快捷键。

自动添加Javadoc注释

在编辑配置时,输入 /** 可以自动生成Javadoc注释:

 

同样的,对函数、变量也会自动加入注释。只要事先配置好Comment模板即可,不配置时Eclipse会提供默认模板。

附录

posted on 2014-07-31 23:16  PrintJ  阅读(583)  评论(0编辑  收藏  举报

导航