Java代碼規範文檔

標籤：

 NOTE：以下部分為一個簡要的編碼規範，更多規範請參考 ORACLE官方文檔。

  地址：http://www.oracle.com/technetwork/java/codeconventions-150003.pdf

  另外，請使用 UTF-8格式來查看代碼，避免出現中文亂碼。

  

至於注釋應該使用中文還是英文，請自己行決定，根據公司或項目的要求而定，推薦使用英文。

    1. 整理代碼

      1.1. Java代碼中不允許出現在警告，無法消除的警告要用 @SuppressWarnings。

     1.2.去掉無用的包、方法、變數等，減少殭屍代碼。

     1.3.使用 Lint 工具來查看並消除警告和錯誤。

     1.4.使用 Ctrl+Shift+F 來格式化代碼，然後再進行調整。

     1.5.使用 Ctrl+Shift+O 來格式化 Import 包。

  2. 命名規則

     2.1.基本原則 

          2.1.1.變數，方法，類命名要表義，嚴格禁止使用 name1, name2 等命名。

          2.1.2.命名不能太長，適當使用簡寫或縮寫。（最好不要超過 25 個字母）

          2.1.3.方法名以小寫字母開始，以後每個單字首大寫。

          2.1.4.避免使用相似或者僅在大小寫上有區別的名字。

          2.1.5.避免使用數字，但可用 2 代替 to，用 4 代替 for 等，如go2Clean。  

 

     2.2.類、介面

    

          2.2.1.所有單詞首字母都大寫。使用能確切反應該類、介面含義、功能等的詞。一般採用名詞。

          2.2.2.介面帶 I 首碼，或able, ible,er等尾碼。如ISeriable。

    

    

     2.3.欄位、常量

    

          2.3.1.成員變數以 m 開頭，靜態變數以 s 開頭，如 mUserName, sInstance。

          2.3.2.常量全部大寫，在詞與詞之前用底線串連，如 MAX_NUMBER。

          2.3.3.代碼中禁止使用寫入程式碼，把一些數字或字串定義成常用量。

          2.3.4.對於廢棄不用的函數，為了保持相容性，通常添加 @Deprecated，如{@link #doSomething()}

    

         

  3. 注釋

     請參考 {@link #SampleCode}類的注釋。

    

     3.1.常量注釋，參見 {@link #ACTION_MAIN}

     3.2.變數注釋，參見 {@link #mObject0}

     3.3.函數注釋，參見 {@link #doSomething(int,float, String)}

     

    

  4. Class內部順序和邏輯

 

     4.1.每個 class 都應該按照一定的邏輯結構來排列基成員變數、方法、內部類等，

             從而達到良好的可讀性。

     4.2.總體上來說，要按照先 public, 後protected, 最後 private, 函數的排布

             也應該有一個邏輯的先後順序，由重到輕。

     4.3.以下順序可供參考：

          定義TAG，一般為 private（可選）

         定義 public 常量

         定義 protected 常量、內部類

         定義 private 變數

         定義 public 方法

         定義 protected 方法

         定義 private 方法

         

 

  5. 運算式與語句

     5.1.基本原則：採用緊湊型風格來編寫代碼

     5.2.細則

    

          5.2.1.條件表示式，參見 {@link #conditionFun(boolean)}

          5.2.2. switch語句，參見 {@link #switchFun(int)}

          5.2.3.迴圈語句，參見 {@link#circulationFun(boolean)}

          5.2.4.錯誤與異常，參見 {@link #exceptionFun()}

          5.2.5.雜項，參見 {@link #otherFun()}

          5.2.6.批註，參見 {@link #doSomething(int,float, String)}

      

Java代碼規範文檔