Android程式碼的書寫規範

mymdeep發表於2017-02-03
Android

畢業工作也有幾年了，從開始學習寫程式碼的時候就沒有養成好的程式碼習慣，野路子起家，但是隨著工作的深入，越發感覺，程式碼的簡潔清楚就像是程式設計師的臉面，寫出規範的程式碼，對個人，對團隊都是非常重要的。下面我就簡述一下程式碼的規範。

遵循的格式

使用花括號

if else for do while等語句要和花括號一起使用，哪怕只有一句話，也要加上花括號。如：

if（isTrue）
    true();
else
    false();複製程式碼

這樣的寫法就是不正確的，如下的寫法才是正確的：

if（isTrue）{
    true();
}else{
    false();
}複製程式碼

列字元限制

根據IDE具體顯示的情況分析，為了提高閱讀性，一般那一行80-100個字元為宜，超過部分換行

switch

switch語句除了應有的首行縮排以外，一定要加上default語句。如果連續兩個case之間確定不要加入break的時候，建議加上//fall through

命名約定

類的命名

類的命名遵循大駝峰的命名法MainActivity
大駝峰命名法所有單詞的第一個字母大寫

方法的命名

方法的命名遵循小駝峰的命名法 startActivity。
除了首單詞外，其餘所有單詞的第一個字母大寫。

package命名

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

介面的命名

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

變數的命名

採用小駝峰命名法。類中控制元件名稱必須與xml佈局id保持一致。
作用統一的變數，在結尾加一個量詞進行區分更容易搜尋和記憶。如
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
圖片的命名以ic為字首,例如ic_share.png
背景圖片可以用bg作為字首。

註釋的規範

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

其他編碼規範

除了以上的規範，我還從網上找到了一些其他比較重要的注意點，總結如下：
1.java中儘量不出現中文
2.服務端可以實現的，就不要放在客戶端
3.引用第三方庫要慎重，避免應用大容量的第三方庫，導致客戶端包非常大
4.使用靜態變數方式實現介面間共享要慎重
5.不要重用父類的handler，對應一個類的handler也不應該讓其子類用到，否則會導致message.what衝突
6.activity中在一個View.OnClickListener中處理所有的邏輯
7.如果多個Activity中包含共同的UI處理，那麼可以提煉一個CommonActivity，把通用部分叫由它來處理，其他activity只要繼承它即可
8.如果所開發的為通用元件，為避免衝突，將drawable/layout/menu/values目錄下的檔名增加字首。
更多的開發知識，可以關注我的公眾號：

Android程式碼的書寫規範

相關文章