使Eclipse符合Java编程规范

编程规范是很重要的东西，能让团队的代码易于阅读和维护，也便于日后的功能扩展。

工欲善其事必先利其器！作为一个Java程序员，与Eclipse打交道可能是一辈子的事情。将Eclipse设置为符合公司编程规范的模式，将节省我们很多时间。

使用Eclipse的都知道 Ctrl + Shift + F 这个快捷键的作用，就是自动将书写的代码排版，变得易于阅读。

刚进入公司的时候，老程序员告诉我，不要使用这个快捷键，因为它会使代码变乱，例如自动让一个很长方法的不同参数整理到不同行上。其实他不知道的是，Ctrl + Shift+ F是基于一定规则的，这些规则都是可以自己设置的。

将Eclipse按照公司编程规范设置好了之后，写完代码，一个Ctrl + Shift + F,页面就会变得整洁又好看。阅读别人的代码的时候，也是一样。

这里不讲正规的编程规范，只讲怎么根据编程规范，一步步来设置我们的Eclipse。

1、 设置JDK版本、编码格式 

 Eclipse中的基本设置都是在Windows ->  Preferences 中设置的。而Java编程的个性化设置就位于Windows ->  Preferences -> Java中。

（1）、JDK版本

进行Java开发，首先要设置JDK版本。MyEclipse有自带的Jdk，而eclipse没有。

采用如下的步骤设置自定义的JDK。

首先在Java -> Complier中，将Compiler compliance level 设置为1.6 。

然后在Java -> Installed JREs右边目录中，可以看到JDK地址，需要增加JDK,可以通过add -> Stankard VM -> Next ->Directory ，定位到JDK文件夹，Finish！

(PS:这里附jdk 路径设置：

CLASSPATH= .;%JAVA_HOME%/lib/dt.jar;%JAVA_HOME%/lib/tools.jar

JAVA_HOME = C:/Program Files/Java/jdk1.5.0

PATH  = %JAVA_HOME%/bin;%JAVA_HOME%/jre/bin)

 

（2）、编码格式

preferences->General 点击 workspace，右边下面有一个Text file encoding，点击Other，选择Utf-8，以后新建的项目都是utf-8编码的。

 

2、Java Doc设置（注释模版）

Window -> Preferences -> Java -> Code Style 中有大量设置代码风格的设置，注释模版在Code Style->Code Templates中设置。

（1）、文件头JavaDoc模版设置：

Comments -> Files，右边点击Edit...,将公司文件头JavaDoc范例覆盖进去，如下：

/**

* Copyright <year> Xxx Inc.

*/

（2）、类/接口、方法等JavaDoc模版设置都跟上面类似：

同理，Comments -> type设置类/接口JavaDoc模版，Methods设置方法。

 

（附：javadoc注释标签语法
　　@author    对类的说明 标明开发该类模块的作者
　　@version   对类的说明 标明该类模块的版本
　　@see      对类、属性、方法的说明 参考转向，也就是相关主题
　　@param    对方法的说明 对方法中某参数的说明
　　@return    对方法的说明 对方法返回值的说明
　　@exception  对方法的说明 对方法可能抛出的异常进行说明 ）

下面是网上搜到的一个很标准的注释模版：

文件(Files)注释标签：
/**  
* @Project: ${project_name}
* @Title: ${file_name}
* @Package ${package_name}
* @Description: ${todo}
* @author qsk
* @date ${date} ${time}
* @Copyright: ${year} www.xxx.cn Inc. All rights reserved.
* @version V1.0  
*/
类(Types)注释标签（类的注释）：
/**
* @ClassName: ${type_name}
* @Description: ${todo}
* @author qsk
* @date ${date} ${time}
* @version v1.0
* ${tags}
*/
字段(Fields)注释标签：
/**  @Fields ${field} : ${todo} */

构造函数标签：
/**
* <p>Title: </p>
* <p>Description: </p>
* ${tags}
*/

方法(Constructor & Methods)标签：
/**
* @Title: ${enclosing_method}
* @Description: ${todo}
${tags}                                                                                                                                                                                         * @author qsk
* @throws
*/
覆盖方法(Overriding Methods)标签：
/*
* <p>Title: ${enclosing_method}</p>
* <p>Description: </p>
* ${tags}
* ${see_to_overridden}
*/

代表方法(Delegate Methods)标签：
/**
* ${tags}
* ${see_to_target}
*/

getter方法标签：
/**
* @return ${bare_field_name}
*/
setter方法标签：
/**
 * @param ${param} the ${bare_field_name} to set
 */

 

3、代码风格设置

我们可以根据需要设置自己的Formatter。

在Code Style选项中，选择Formatter我们选择新建自己的Formatter,点击"New...",设置名称。

随后跳转到风格详细设置页面。

下面详细讲一下Fomatter的风格设置页面的各个选项卡。

（1）设置Eclipse中的tab键为4个空格，这个比较麻烦。

首先，在第一个选项卡Indentation下有一个Tab policy选项，选择spaces only 保存即可。

然后，设置用空格代替TAB，window->preference ->General->Editors->Text Editors，右侧有一个insert space for tabs，选中，保存；

 

（2）第一个选项卡Indentation就是设置缩进的，选择后，右边的Preview有直接变化，可观察。

Statements within 'switch' body 选项一般应该勾上。

 

（3）第二个选项卡Braces是设置括号是否换行。

一般除了class/Interface和数组（即第一个和最后一个）设置为Same Line之外，其他都设置为Next Line。

 

（4）第三个选项卡White Space是设置空格的。

一般逗号后必须空一格、所有的运算符、赋值符前后必须空一格，所有关键字与其它关键字、非关键字之间必须空一格。

由于设置太繁琐，这里就不一一列出了，很简单。

 

（5）第四个选项卡Blank Lines是设置空行的。

 

（6）第五个选项卡New Lines是设置大括号换行的。

 

（7）第六个选项卡Control Statements是设置控制语句格式的。

Insert new Line before 'else' in an 'if' statement这个选项一般要勾上。

 

（8）第七个选项卡Line Wrapping是设置行距、缩进、行最大长度的各种具体数值。

这里，为了使自动格式化的时候不会随便换行，可以将Maximum line width设置的大一点，我就直接设为500。

 

（9）第八个选项卡Comments是设置注释格式的。

 

（10）第九个选项卡Off/On Tags是设置注释中标签开关的。

 

4、 链接JDK类库帮助文档（API） 

我们知道，在Eclipse中，对着某个类使用 Shift+F2 可以打开它的API文档，可是，由于各种原因，经常打不开，而实际上这个是可以设置的。如下：

（1） Window -> Preferences -> Java -> Installed JREs 

选中已有的使用中的JDK，点击右边的Edit

对话框中央有一个JRE system libraries列表，里面有9个jar包。

 

（2）展开一个Jar包，里面有2个文件，一个是类源文件src.zip，一个是javadoc location:(none)，我们要做的就是把这个空地址替换成我们硬盘上API文档的实际地址。选择javadoc location，点击右边的Javadoc Location...选项，在弹出框中点击Browse...,输入硬盘上API文档的实际地址即可。

 

（3）依次把每个jar包都设置一遍，最后，当我们选择某个JDK类的，Shift + F2的时候，就可以在eclipse中直接打开该类相应的API文档了。

 

 5、编码格式、字体、背景颜色设置

除了上面关乎编程规范的设置外，很多个性化的设置可以让Eclipse更易于使用。

（1）、字体设置

preferences->General->Appearance->Colors and Fonts 右边列表选择 Java-> Java Editor Text Font，点击Edit...就可以改变java字体了。

这里的字体设置并不会影响xml、txt、properties 等文件的字体，而初始化xml、txt、properties 文件的字体一般都很小，不易观察，看下面的设置。

 

（2）、xml、txt、properties 字体设置

preferences -> General -> Appearance -> Colors and Fonts 右边列表选择 Basic -> Text font ，点击Edit...就可以改变字体了。

有时候觉得控制台的字体不醒目，想换一种，可以采用下面的方式。

 

（3）、debug字体设置

preferences -> Appearance -> colors and fonts 右边列表选择 debug -> console font ，点击Edit...就可以改变字体了。

其他的字体设置都大概类似。

长期对着电脑，白亮的色彩会让程序员眼睛发昏，注意力不能集中，设置一下背景颜色，可以很好的缓解这个问题。

 

（4）、背景颜色设置

preferences -> General -> Editors ->Text Editors 选中它，右边的面板有一个Appearance color options，用来设置各种模块的颜色。

选择Background color，去掉右边的System Default的勾选，点击Color，在里面设置颜色。

眼科专家推荐背景颜色为：色调85、饱和度123、亮度205，设置完，美观大方的浅绿色就出现了。

 

------------------------------------------------------------------------------------------------------------------------------------------------------------

PS：如果本篇博文您觉得不错的话，请别忘了推荐一下，谢谢。

* @author qsk