類的大體描述放在這裏。
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. 代碼中禁止使用硬編碼(hardcode),把一些數字或字符串定義成常用量。
2.3.4. 對於廢棄不用的函數,爲了保持兼容性,通常添加 @Deprecated,如
doSomething()
3. 註釋
請參考 SampleCode
類的註釋。
3.1. 常量註釋,參見
ACTION_MAIN
3.2. 變量註釋,參見
mObject0
3.3. 函數註釋,參見
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. 條件表示式,參見
conditionFun(boolean)
5.2.2. switch 語句,參見
switchFun(int)
5.2.3. 循環語句,參見
circulationFun(boolean)
5.2.4. 錯誤與異常,參見
exceptionFun()
5.2.5. 雜項,參見
otherFun()
5.2.6. 批註,參見
doSomething(int, float, String)
Since:
2013-XX-XXz
Author:
作者名