【Android】【基礎(chǔ)篇】編碼規(guī)范

寫在前面:

不論是哪種語言,規(guī)范的編碼總能準(zhǔn)確描述表達(dá)的含義,讓人較容易明白,好的代碼規(guī)范能夠省去很多注釋,提高同事之間的工作效率。

下面就總結(jié)一下我平時用到的代碼規(guī)范。


先介紹兩種命名規(guī)則:

駝峰命名法:又稱小駝峰命名法。除了首個單詞首字母小寫除外,其余所有單詞所有首字母都要大寫。

帕斯卡命名法:又稱大駝峰命名法。所有單詞首字母大寫。


1、包的命名規(guī)范

所有單詞小寫,只能包含a-z字母,或有含義的阿拉伯?dāng)?shù)字如4代替for,2代替to

建議采用如下規(guī)則:【com】.【公司名/組織名】.【項目名稱】.【模塊名】

常見的包分層結(jié)構(gòu)如下:

com.xxx.xxx.view –> 自定義view 或者是View接口

com.xxx.xxx.activities –> activity類

com.xxx.xxx.fragments –> fragment類

com.xxx.xxx.adapter –> 適配器相關(guān)

com.xxx.xxx.utils –> 公共工具類

com.xxx.xxx.bean –> 實(shí)體類

com.xxx.xxx.service –> service服務(wù)

com.xxx.xxx.broadcast –> 廣播接收器

com.xxx.xxx.db –>數(shù)據(jù)庫操作類

com.xxx.xxx.persenter –> 中間對象

com.xxx.xxx.model –> 數(shù)據(jù)處理類


2、類的命名規(guī)范

首字母大寫,大駝峰命名法,使用名詞。

Activity ? ? ? ? ? ? ? ? ? ? ? ?類Activity為后綴標(biāo)識 ? ? ? ? ? ? ? ?

Adapter類 ? ? ? ? ? ? ? ? ? ?Adapter 為后綴標(biāo)識 ? ? ? ? ? ? ?

解析類 ? ? ? ? ? ? ? ? ? ? ? ? Parser為后綴標(biāo)識 ? ? ? ? ? ? ? ? ??

工具方法類 ? ? ? ? ? ? ? ? ?Util或Manager為后綴標(biāo)識 ? ? ?

管理類 ? ? ? ? ? ? ? ? ? ? ? ? Manager為后綴標(biāo)識 ? ? ? ? ? ? ? ??

Service類 ? ? ? ? ? ? ? ? ? ?以Service為后綴標(biāo)識?

Receiver類 ? ? ? ? ? ? ? ? ?以Receiver為后綴標(biāo)識

ContentProvider ? ? ? ? ?以Provider為后綴標(biāo)識

自定義基類 ? ? ? ? ? ? ? ? ?以Base開頭

自定義view ? ? ? ? ? ? ? ? ?功能描述 + View

自定義widget ? ? ? ? ? ? ? 模塊名 + 類型(List/Info) + Widget


3、常量命名

所有單詞大寫,單詞間以”_“分隔


4、變量命名

駝峰命名。成員變量以m開頭;靜態(tài)變量以s開頭


5、方法命名

與java開發(fā)類似,采用駝峰命名規(guī)則。首單詞首字母小寫,其余單詞首字母大寫。盡量不要使用下劃線。

6、資源文件

1)布局文件

Activity-------------------activity_

Fragment-------------------fragment_

Dialog-------------------dialog_

PopupWindow-------------------popup_

Menu-------------------menu_

Adapter-------------------layout_item_

(2)圖片

bg_xxx-------------------背景圖片

btn_xx-------------------按鈕

ic_xxx-------------------單個圖標(biāo)

bg _ 描述 _ 狀態(tài)-------------------控件上的不同狀態(tài)

btn _ 描述 _ 狀態(tài)-------------------按鈕上的不同狀態(tài)

chx _ 描述 _ 狀態(tài)-------------------選擇框,一般2態(tài)或4態(tài)

(3)anim目錄下的命名規(guī)范

單詞全部小寫,單詞之間采用下劃線分割。

fade_in.xml

fade_out.xml

slide_in_from_left.xml

slide_in_from_top.xml

slide_out_to_right.xml

slide_out_to_bottom.xml



目前收集到的結(jié)合平時自己的使用習(xí)慣大概就這些,好的命名規(guī)范是一項重要的技能,可以在團(tuán)隊合作中可以很大限度減少溝通成本。無規(guī)范不成方圓。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容