書寫規範

1. 花括號不要單獨一行，和它前面的程式碼同一行。而且，花括號與前面的程式碼之間用一個空格隔開。
   

   public void method() { // Good 
    
   } 
    
   public void method()
   { // Bad
   }  
    
   public void method(){ // Bad
    
   }

   
   
2. if、else、for、switch、while等邏輯關鍵字與後面的語句留一個空格隔開。
   

   // Good
   if (booleanVariable) {
       // TODO while booleanVariable is true
   } else {
       // TODO else
   }
    
   // Bad
   if(booleanVariable) {
       // TODO while booleanVariable is true
   }else {
       // TODO else
   }
    
   

3. 運算子兩邊各用一個空格隔開。
   

   int result = a + b; //Good, = 和 + 兩邊各用一個空格隔開
   int result=a+b; //Bad,=和+兩邊沒用空格隔開

4. 方法的每個引數之間用一個空格隔開。
   

   public void method(String param1, String param2); // Good，param1後面的逗號與String之間隔了一個空格
   method(param1, param2); // Good，方法呼叫時，param1後面的逗號與param2之間隔了一個空格
   method(param1,param2); // Bad，沒有用個空格隔開

   
   
   
5. 空行的使用
   
   將邏輯相關的程式碼段用空行隔開，以提高可讀性。空行也只空一行，不要空多行。在以下情況需用一個空行：
   兩個方法之間
   方法內的兩個邏輯段之間
   方法內的區域性變數和方法的第一條邏輯語句之間
   常量和變數之間
   
   
6. 當一個表示式無法容納在一行內時，可換行顯示，另起的新行用8個空格縮排。
   

   someMethod(longExpression1, longExpression2, longExpression3,  
           longExpression4, longExpression5);

   
   
   
7. 一行宣告一個變數，不要一行宣告多個變數，這樣有利於寫註釋。
   

   private String param1; // 引數1
   private String param2; // 引數2

   
   
   
8. 一個方法最多不要超過40行程式碼。
   
   
9. 範圍型的常量用列舉類定義，而不要直接用整型或字元，這樣可以減少範圍值的有效性檢查。
   

   // 用列舉類定義，Good
   public enum CouponType {
       // 現金券
       @SerializedName("1")
       CASH,
    
       // 抵用券
       @SerializedName("2")
       DEBIT,
    
       // 折扣券
       @SerializedName("3")
       DISCOUNT
   }
    
   // 用整型定義，Bad
   public static final int TYPE_CASH = 1; // 現金券
   public static final int TYPE_DEBIT = 2; // 抵扣券
   public static final int TYPE_DISCOUNT = 3; // 折扣券
    
   

   
   
10. 水平對齊：不做強制要求
    

    private  int  x ;     // this is fine
    private  Color  color ;    // this too
     
    private  int       x ;            // permitted, but future edits
    private  Color  color ;      // may leave it unaligned

1. 包命名
   包名全部用小寫字母，通過 . 將各級連在一起。不應該使用下劃線。
   com.shaonaozu.application
   
   
2. 類和介面的命名
   型別的命名，採用以大寫字母開頭的大小寫字元間隔的方式（UpperCamelCase）。
   class命名一般使用名詞或名詞短語。interface的命名有時也可以使用形容詞或形容詞短語。
   
   測試類的命名，應該以它所測試的類的名字為開頭，並在最後加上Test結尾。例如：HashTest 、 HashIntegrationTest。
   
   
3. 方法的命名
   方法命名，採用以小寫字母開頭的大小寫字元間隔的方式（lowerCamelCase）。
   方法命名一般使用動詞或者動詞短語。
   
   初始化方法，命名init開頭，比如：initView
   按鈕點選方法，命名以to開頭，比如：toLogin
   設定方法，以set開頭，比如：setData
   具有返回值的獲取方法，以get開頭，比如：getData
   通過非同步載入資料的方法，以load開頭，比如：loadData
   布林型的判斷方法，以is或has，或具有邏輯意思的單詞如equals，例如：isEmpty
   新增資料，以add開頭，例如：addData
   修改資料，以modify開頭，例如：modifyData
   刪除資料，以delete開頭，比如：deleteData
   
   
4. 常量命名
   常量命名，全部使用大寫字元，詞與詞之間用下劃線隔開。（CONSTANCE_CASE）。
   常量一般使用名詞或者名詞短語命名。
   
   

   static final int NUMBER =5;
   static final SomeEnum { ENUM_CONSTANT }

   
   
   
5.  非常量的成員變數名
   非常量的成員變數命名（包括靜態變數和非靜態變數），採用lowerCamelCase命名。
   一般使用名詞或名詞短語。
   
   
6. 引數名
   引數命名採用lowerCamelCase命名。
   應該避免使用一個字元作為引數的命名方式。
   
   
7. 區域性變數名
   區域性變數採用lowerCamelCase命名。它相對於其他型別的命名，可以採用更簡短寬鬆的方式。
   但即使如此，也應該儘量避免採用單個字母進行命名的情況，除了在迴圈體內使用的臨時變數。
    
   即使區域性變數是final、不可改變的，它也不能被認為是常量，也不應該採用常量的命名方式去命名。
   
   
8. 靜態成員的訪問：應該通過類，而不是物件
   當一個靜態成員被訪問時，應該通過class名去訪問，而不應該使用這個class的具體例項物件。
   

   class Foo {
       static aStaticMethod() {
   
       }
   }
   
   Foo aFoo = ...;
   Foo.aStaticmethod(); //good
   aFoo.aStaticmethod(); //bad

   
   
   

1. 通用格式
   

   /**
    * Multiple lines of Javadoc text are written here
    * wrapped normally ...
    */
   public int method(String p1) {...}

   或單行格式
   

   /** An especially short bit of javaodc */

2. 段落
   
   空白行：是指javadoc中，上下兩個段落之間只有上下對齊的 * 字元的行。每個段落的第一行在第一個字元之前，有一個<p>標籤，並且之後不要有任何空格。
   

   /**
    * Multiple lines of Javadoc text are written here
    * <p>wrapped normally ...</p>
    */
   public int method(String p1) {...}

3. @從句
   所有標準的@從句，應該按照如下的順序新增：@param、@return、@throws、@deprecated。並且這四種@從句，不應該出現在一個沒有描述的Javadoc塊中。
   當@從句無法在一行寫完時，應該斷行。延續行在第一行的@字元的位置，縮排至少4個字元單位。
   

   /**
    * @param model 描述描述描述描述描述描述描述
    *     描述描述描述描述描述
    * @param request
    * @return
    * @throws
    * @deprecated
    */

   
   
   
4. 何處應該使用Javadoc
   至少，Javadoc應該應用於所有的public類、public和protected的成員變數和方法。和少量例外的情況。例外情況如下。
   
   例外：方法本身已經足夠說明的情況
   當方法本身很顯而易見時，可以不需要javadoc。例如：getFoo。沒有必要加上javadoc說明“Returns the foo”。
   單元測試中的方法基本都能通過方法名，顯而易見地知道方法的作用。因此不需要增加javadoc。
    
   注意：有時候不應該引用此例外，來省略一些使用者需要知道的資訊。例如：getCannicalName 。當大部分程式碼閱讀者不知道canonical name是什麼意思時，不應該省略Javadoc,認為只能寫/** Returns the canonical name. */ 。
   
   例外：過載方法
   過載方法有時不需要再寫Javadoc。