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

本文包含以下内容：

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会提供默认模板。

附录

Java编程规范实践的更多相关文章

  1. FangDD Java编程规范

    我们采用<Oracle/Sun原生的Java编程规范>和<Google Java编程规范> Google Java编程风格指南 January 20, 2014 作者:Haws ...

  2. JAVA编程规范（下）

    JAVA编程规范(下) 2016-03-27 6. 代码的格式化 6.1 对代码进行格式化时,要达到的目的 1.     通过代码分割成功能块和便于理解的代码段,使代码更容易阅读和理解: 2.     ...

  3. JAVA 编程规范(上)

    2016-03-20 J120-CHARLIEPAN JAVA 编程规范(上) 1.      应用范围 本规范应用于采用J2EE规范的项目中,所有项目中的JAVA代码(含JSP,SERVLET,JA ...

  4. Java编程规范（一）

    最近在看一本有关Java编程规范的书,书中精炼阐述了使用java语言时应该遵循的一些原则.接下来的一段时间我将在这里总结我的学习内容,也希望这一系列文章能够对有需要的人有所帮助. 不考虑任何编码规范的 ...

  5. Java编程规范（二）

    二.格式规范 在上一篇的java编程规范(一)中我们讲述了在Java编码中的一般原则,虽然这些原则并不涉及具体的代码规范,但是这些原则却是我们在Java开发过程中所应该遵循的规范与思想.今天我们将学习 ...

  6. Java编程规范参考

    谷歌Java编程规范-原版 谷歌Java编程规范-中文翻译版 阿里巴巴Java编程规范 阿里巴巴Java编程规范-IDEA 插件 阿里巴巴Java编程规范-Eclipse 插件

  7. 乐字节Java变量与数据类型之一：Java编程规范，关键字与标识符

    大家好,我是乐字节的小乐,这次要给大家带来的是Java变量与数据类型.本文是第一集:Java编程规范,关键字与标识符. 一.编程规范 任何地方的名字都需要见名知意: 代码适当缩进 书写过程成对编程 对 ...

  8. 阿里巴巴Java编程规范考试

    阿里巴巴Java编程规范考试 今天在阿里云官网把阿里巴巴Java编程规范认证考试考过了, 写下这篇文章总结一下考试中需要注意的知识点, 主体内容还是要直接看规范: 编程规约 异常日志 单元测试 安全规 ...

  9. java编程规范大全

    JAVA编程规范大全 命名规范 定义这个规范的目的是让项目中所有的文档都看起来像一个人写的,增加可读性,减少项目组中因为换人而带来的损失.(这些规范并不是一定要绝对遵守,但是一定要让程序有良好的可读性 ...

随机推荐

  1. bjfu1262 优先队列

    比较典型的应用优先队列的题.题目是在一个长为n的数组中,依次问m个数中的最小值.那么把值和下标做成一个结构体,放进优先队列里,每次移动窗口就把该T的T掉,剩下的最小值就是答案,复杂度nlogn,轻松a ...

  2. nohub命令

    http://jingyan.baidu.com/article/335530daa4707f19cb41c3ef.html

  3. php连接数据库

    <?php header('Content-Type:text/html; charset=utf-8'); define('DB_HOST', 'localhost'); define('DB ...

  4. （phpmyadmin error）Login without a password is forbidden by configuration (see AllowNoPassword) in ubuntu

    1.Go to /etc/phpmyadmin/config.inc.php and open it your favorite editor. 2.Search for below line of ...

  5. 轻松学习Linux之Shell文件和目录属性详解

    轻松学习Linux之Shell文件和目录属性详解 轻松学习Linux之理解Sitcky 轻松学习Linux之理解umask 轻松学习Linux之理解SUID&SGUID 本系列多媒体教程已完成 ...

  6. Hadoop 1.1.2 Eclipse 插件使用——异常解决

    permission denied user 1.修改配置文件在conf/hdfs-site.xml文件中添加如下内容: <property> <name>dfs.permis ...

  7. 解决ehcache的UpdateChecker问题

    问题描述 项目中用了ssh框架,每次启动tomcat的时候都特别慢,会在这样一句话下面停留很久 [2016-01-08 23:55:51,517 INFO UpdateChecker.java:doC ...

  8. poj 2594 Treasure Exploration(最小路径覆盖+闭包传递)

    http://poj.org/problem?id=2594 Treasure Exploration Time Limit: 6000MS   Memory Limit: 65536K Total ...

  9. oracle不用tsname文件的时候着怎么办

    oracle\product\10.2.0\client_2\odp.net\PublisherPolicy\Policy.9.2.Oracle.DataAccess.config 找到newVers ...

  10. android adb服务启动不了解决办法

    当然还有可能是其它的原因,下面是一些解决办法的汇总 因为在对应的文件夹下找不到adb的问题,将android-sdk/platform-tools和android-sdk/tools都加到环境变量中去 ...