使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


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM