Android程式碼書寫規範

摘要： package命名：全部使用小寫字母。一級包名為com，二級包名為xx（可以是公司或則個人的隨便），三級包名根據應用進行命名，四級包名為模組名或層級名。 類的命名：大駝峰的命名法，如：MainA...

• package命名：全部使用小寫字母。一級包名為com，二級包名為xx（可以是公司或則個人的隨便），三級包名根據應用進行命名，四級包名為模組名或層級名。

• 類的命名：大駝峰的命名法，如：MainActivity

• 方法的命名：小駝峰的命名法，如：startActivity。

• 介面的命名：命名規則與類一樣採用大駝峰命名法，多以able或ible結尾。

• 變數的命名：採用小駝峰命名法。

  注意：作用統一的變數，在結尾加一個量詞進行區分更容易搜尋和記憶，如strNameFirst和strNameLast

• 常量的命名：常量全部大寫，如：MIN MAX

• 佈局檔案的命名：佈局檔案使用“字首_邏輯名”的方式，單詞全部小寫：

  ①activity的佈局——activity_xxx

  ②fragment的佈局——fragment_xxx

  ③自定義控制元件的佈局——view_xxx

  ④對話方塊的佈局——dialog_xxx

  ⑤列表項的佈局——item_xxx

• 資原始檔的命名：資原始檔使用“模組名_邏輯名”方式，單詞全部小寫：

  ①按鈕以btn為字首，如果是圖片可以是btn_login.png，按鈕的點選形態可以是btn_login_normal.xml以及btn_login_pressed.xml

  ②圖片的命名以iv為字首,例如iv_share.png

  ③背景圖片可以用bg作為字首。

• 註釋的規範：

Javadoc 常見的標記
@param 引數的說明
@return 返回值的說明
@throws 異常的描述
@version 模組的版本號
@author 模組作者
@see 參考轉向
@deprecated 標記是否過時

• 其他編碼規範：除了以上的規範，其他比較重要的注意點，總結如下：

  ①java中儘量不出現中文

  ②服務端可以實現的，就不要放在客戶端

  ③引用第三方庫要慎重，避免應用大容量的第三方庫，導致客戶端包非常大