Android在Code的提供上有規定Code Style

以下就介紹一下參考資料

 

Java Language Rules

Don't Ignore Exceptions 不要忽略例外處理
可以接受的處理方式有
a. 直接拋出例外
b. 拋出自定的抽象例外
c. 直接在例外中處理
d. 拋出處理過的例外
e. 用註解說名
不要使用
a. Exception來捕捉全部例外

Don't Use Finalizers 不要使用Finalizers
不要主動使用Finalizer來做GC

Fully Qualify Imports 使用完整的imports
不使用*來import

Java Library Rules 使用Library的規則
不要使用deprecated的libraries

Use Javadoc Standard Comments 使用Java標準的註解方式
著作權相關的放最上方
method上方有註解說明功能

Write Short Methods 簡短的Methods
不要超過40行

Define Fields in Standard Places 在標準的地方定義變數
定義變數在立即要使用的地方或是在最上方

Limit Variable Scope
使變數的最少化
變數初始化時有用到try-catch則可以拉出來寫
for迴圈改用Iterator

Order Import Statements 使用Import的順序
a. Android imports
b. Imports from third parties (com, junit, net, org)
c. java and javax
按照A~Z然後a~z的順序
用空白來分離不同的group

Use Spaces for Indentation 用空白來縮排
用4個空白來處理區塊內的縮排
用8個空白來表示同行後的換行

Follow Field Naming Conventions 遵守Field命名公約
非public, static的則在前面加m
static變數前面加s
其餘用小寫
常數用大寫加底線

Use Standard Brace Style
{ 寫在最後
如果只有一行敘述可寫在同一行但不要分行

Limit Line Length 每行長度限制
一行不要超過100字, 除了url或是import

Use Standard Java Annotations 使用Java標準的Annotations
@Deprecated 使用時要添加Javadoc
@Override 父類別中有的時候就要使用
@SuppressWarnings 在不可能被消除的情況下使用

Treat Acronyms as Words 使用單字縮寫
XmlHttpRequest 優於 XMLHTTPRequest
getCustomerId 優於 getCustomerID
class Html 優於 class HTML
String url 優於 String URL
long id 優於 long ID

Use TODO Comments 使用TODO註解
TODO是一個暫時性的註解, 當確保未來需要實踐或改變時則使用

Log Sparingly 保守的使用Log
ERROR: 用來會造成crash的行為
WARNING: 用來秀非預期但是不會crash的行為
INFORMATIVE: 用來秀出使用者常發生的行為
DEBUG: 用來方便調查非預期的行為
VERBOSE: 在任何地方都可以使用

只有在最終的function會秀error
拋出例外時則不需要使用
避免丟出同樣的資訊
網路段線時要用DEBUG或VERBOSE來log
秀出檔案系統filesystem不要用超過INFORMATIVE的層級
當不可信任的來源輸入而且無效時, 要用高於DEBUG層級來log
Log.v會被包在release執行
StringBuilders比用String和+共同使用有著高效率
Log的內容要有可讀性不需加密
字數不要超過130或160字元, 最好在80或100之內
回報成功不要使用高過VERBOSE的層級
不要在log上秀出敏感資訊, 像是私密訊息等
不要使用System.out.println()來秀log, 會產生看不見的影響

Be Consistent 連貫性
要注意code的前後是否有用相同的命名,空白, 風格等等

 

1. 官網http://source.android.com/source/code-style.html

01.png  

arrow
arrow

    RX1226 發表在 痞客邦 留言(0) 人氣()