Java code standard 
1.   介紹/說明 
1.1  宣告
本文件內容描述寰信通JAVA編碼規範，凡是在寰信通開發的JAVA程式必須按照此文件規定.

1.2  為什麼要有編碼規範
編碼規範對於開發人員來說是非常重要的，有以下幾個原因：

一個軟體的生命週期中，80%的花費在於維護

幾乎沒有任何一個軟體，在其整個生命週期中，均由最初的開發人員來維護

編碼規範可以改善軟體的可讀性，可以讓程式設計師儘快而徹底地理解新的程式碼

如果你將原始碼作為產品釋出，就需要確任它是否被很好的打包並且清晰無誤，一如你已構建的其它任何產品

2. 目標 
為來自不同的專案組或個人提供標準的程式碼格式。 
增加易讀性。
 
3. 命名規定 
命名規範使程式更易讀，從而更易於理解。它們也可以提供一些有關識別符號意圖的資訊，有助於開發人員理解程式碼。 
3.1  包的命名 
包的命名應該都是小寫字母，單詞之間用“.”分開。所有的JAVA檔案必須建立在com.global包下。例如： 
package com.global.water.system; 
package com.global.cctv.system; 
3.2  類的命名 
 類的命名應該都是名詞，第一個字母都要大寫，其他每個單詞的第一個字母都要大寫。要用完整的單詞，除非是被公認的單詞縮寫。例如： 
class Container 
class ShippingLine 
3.3  介面的命名 
 介面的命名應該都是名詞或形容詞，第一個字母都要大寫，其他每個單詞第一個字母都要大寫。要用完整的單詞，除非是被公認的單詞縮寫。例如： 
interface ContainerOwner 
interface Runnable 
3.4  方法的命名 
 方法的命名應該都用動詞或是慣用短語描述，第一個字母都要小寫，其他每個單詞第一個字母都要大寫。例如： 
run() 
changeLocationTo() 
getContainerId() 
3.5  變數的命名 
 所有非靜態變數名的第一個字母都要小寫，其他每個單詞的第一個字母都要大寫。命名應儘量簡單並且要有意義。變數名的選用應該易於記憶，能夠指出其用途。儘量避免單個字元的變數名，除非是一次性的臨時變數。臨時變數通常被取名為i，j，k，m和n，它們一般用於整型；c，d，e，它們一般用於字元型。變數名不應以下劃線或美元符號開頭，儘管這在語法上是允許的。下面是一些正確的變數命名例子： 
int numOfContainers 
String containerId; 
Date today; 
3.6常量命名
對於靜態的final變數，在命名的時候每一個單詞都要大寫，單詞之間用“_”分開。例如： 
final static MIN_WIDTH = 4; 
final static DEFAULT_CONTAINER_SIZE = 20; 
3.7檔案的命名 
java源程式檔案以.java結尾，編譯後的檔案以.class結尾。例如： 
Container.java 
Container.class 
3.8  推薦的命名 
3.8.1  類名推薦 
當要區別介面和實現類的時候，可以在類的後面加上“Impl”。例如： 
interface Container 
class ContainerImpl 
class Container3PImpl 
class ContainerYICTImpl 
3.8.2  Exception類名推薦 
Exception類最好能用“Exception”做為類命名的結尾。例如： 
DataNotFoundException 
InvalidArgumentException 
3.8.3  抽象類名推薦 
抽象類最好能用“Abstract”做為類命名的開頭。例如： 
AbstractBeanDefinition 
AbstractBeanFactory 
3.8.4  Test類名推薦 
Test類最好能用“Test”做為類命名的結尾。例如： 
ContainerTest 
3.8.5  工廠類方法推薦 
工廠方法最好能把該方法做要建立的物件型別描述出來。例如： 
public Container createContainer(); 
public Location newLocation();

4.Java檔案組織 
一個檔案由被空行分割而成的段落以及標識每個段落的可選註釋共同組成。超過2000行的程式難以閱讀，所以一個java程式檔案中的程式碼行數不能超過2000行，除非有特殊原因。
每個Java原始檔都包含一個單一的公共類或介面。若私有類和介面與一個公共類相關聯，可以將它們和公共類放入同一個原始檔。公共類必須是這個檔案中的第一個類或介面。
Java原始檔還遵循以下規則，這個規則規定了java程式段落的順序：
- 開頭註釋
- 包和引入語句
- 類和介面宣告

5.   JAVA檔案宣告順序 
 類或介面應該按以下順序宣告： 
 包的定義 
            impot類（輸入包的順序、避免使用*） 
·           輸入包應該按照java.*.*，javax.*.*，org.*.* ，com.*.*的順序import
·           在import的時候不應該使用* (例如: java.util.*)
            類或介面的定義 
            靜態變數定義，按public，protected，private順序 
            例項變數定義，按public，protected，private順序 
            構造方法 
            方法定義順序按照public方法(類自己的方法)，實現介面的方法，過載的public方法，受保護方法，包作用域方法和私有方法。
建議：類中每個方法的程式碼行數不要超過100行。

內部類的定義

6.   JAVA檔案格式縮排定義 
6.1  縮排尺寸 
用4個空格做為縮排尺寸。不建議用TAB代替，因為不同的Text Edit工具對TAB的設定是不同的。 
6.2  行的尺寸 
每行不要超過80個字元。 
6.3  行的格式定義 
當一行表示式不能在一行內顯示，請按下列順序要求拆行： 
          在“(”或“=”符號後拆行,在“,”拆行,在一個操作符後拆行 
 把併發的拆行放到同一級別上的縮排 
 如果在拆行中再次拆分的時候遇到“(”，應該新拆出來的行放在更遠的一個縮排級別上

例如：methodWithLongName( 
          expression1, expression2, expression3, 
          expression4, expression5); 
var = method1( 
        expression1, expression2, 
        method2( expression3, expression4));

7.   註釋 
Java有兩種註釋方法。“/* This is a comment */”或 “// This is a comment” 
第一種應該被用到寫JavaDoc上，並且都用“/**”開頭。 
第二種適合於在做部分程式碼的註釋，但只適合做非常短內容的註釋。

8.   宣告 
8.1  變數宣告 
推薦每行宣告一個變數，並加註釋。例如： 
int count;             // number of containers 
int size;              // size of table 
int count, size;        // AVOID THIS! 
陣列宣告應該採用字首方式。例如： 
int[] table; 
String[] args;

8.2  類或介面宣告 
      “{”和宣告語句在同一行。 
   如果不能在同一行顯示，就將“extends”或“implements”進行拆行，並放在兩個縮排級別後。 
   “}”符號應該獨自佔一行。 
例如： 
public class Manager extends Employee { 
   ...

 } 
public class ChiefExecutiveOfficer 
        extends Manager 
        implements Person {

 } 
8.3  方法宣告 
“{”和宣告語句在同一行。 
“}”符號應該獨自佔一行。

例如： 
public int myMethod(int i, int j) { 
 ... 
}

9.   語句格式 
9.1  return語句 
return 後面的value在比較明顯的時候不要用“()”。例如： 
return; 
return myDisk.size(); 
return (size ? size : defaultSize); 
9.2  if, if-else, if-else-if-else 語句 
例如： 
if (condition) { 
    statements; 
} 
if (condition) { 
    statements;

} 
else { 
    statements; 
} 
if (condition) { 
    statements;
} 
else if (condition) { 
    statements; 
} 
else if (condition) { 
    statements; 
}
9.3  for 語句 
例如： 
for (initialization; condition; update) { 
    statements;
}

9.4  while語句 
例如： 
while (condition) { 
    statements; 
} 
9.5  do-while語句 
例如： 
do {
    statements; 
} 
while (condition); 
9.6  switch語句 
 

例如： 
switch (condition) { 
case ABC: 
    statements; 
case DEF: 
    statements; 
    break; 
case XYZ: 
    statements; 
    break; 
default: 
    statements; 
    break; 
} 
9.7  try-catch語句 
例如： 
try { 
    statements; 
} 
catch (ExceptionClass e) { 
    statements; 
} 
finally { 
    statements; 
}

10. JavaDoc的格式定義 
10.1  檔案頭 
應該包括Copyright，檔案版本等資訊。例如： 
/* 
 * Copyright (C) 2004 北京寰信通科技有限公司. 
 * 
 * 本系統是商用軟體,未經授權擅自複製或傳播本程式的部分或全部將是非法的. 
 *  
 * $$Id:$$ 
 * Date       Author      Description 
 */ 
 10.2  類說明資訊 
定義檔案描述，作者，版本。例如： 
/** 
 * Class description goes here. 
 * 
 * 
 * @author <a href="[email protected]">xxx</a> 
 * @version CVS $$Revision$$ $$Date$$ 
 */ 
10.3  變數定義 
 定義變數描述。例如： 
/** 
 * Comment for <code>${field}</code> 
 */ 
10.4  方法定義 
 定義方法的描述，引數，返回值，參照文件，Exception。例如： 
/** 
  * description 
  * 
  * @param 　方法，變數
  * @return 
  * @exception
  * @see 　　//代表參考．．．．
  * @since 　//代表從什麼版本起
  */