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目錄下的文件名增長前綴。
更多的開發知識，能夠關注個人公衆號：