畢業工作也有幾年了,從開始學習寫代碼的時候就沒有養成好的代碼習慣,野路子起家,但是隨著工作的深入,越發感覺,代碼的簡潔清楚就像是程序員的臉面,寫出規范的代碼,對個人,對團隊都是非常重要的。下面我就簡述一下代碼的規范。
遵循的格式
使用花括號
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目錄下的文件名增加前綴。
更多的開發知識,可以關注我的公眾號: