一、命名規(guī)范
1、包命名
包一律小寫,少用縮寫和長命
采用規(guī)則:[基本包].[項目名].[模塊名]
例如:com.routemap.util
2、類和接口命名
類名是個一名詞,采用大小寫混合的方式,每個單詞的首字母大寫。盡量使你的類名簡潔而富于描述。使用完整單詞,避免用縮寫詞(除非該縮寫詞被更廣泛使用,像URL,HTML)。
1)、抽象類使用A開頭
2)、接口使用I開頭
3)、實現(xiàn)類使用Imple結(jié)尾
4)、頁面類:“Page”,例如“LoginPage”
5)、處理類:“Handle”,例如“LogicHandle”
6)、動作事件定義類:“Action”,例如“LoginAction”
7)、網(wǎng)絡(luò)事件定義類:“Api”,例如“LoginApi”
8)、數(shù)據(jù)定義類:“Entity”,例如“FriendEntity”
9)、消息處理類:“Msg”,例如“LoginRequestMsg”
10)、資源管理類:“Manager”,例如“ImageManager”
11)、緩存類:“Cache”,例如“UserCache”
12)、參數(shù)傳遞類:“Param”,例如“LoginParam”
13)、功能提供類:“XUtil”,例如“XUtilMath”
備注:禁止使用中文字符,不能在命名字符串中出現(xiàn)“0-9”的數(shù)值描述,命名的字母組合盡量能夠在本身的文字意義上初步了解類的大體功能。
3、全局變量命名
1、使用駝峰命名法,首字母用小寫m開頭以便和局部變量區(qū)分(使用完整單詞)
例如:mUserName
2、組件或部件變量使用其類型名或類型名縮寫作其后綴
例如:ImageView mPetHeaderIV
TextView mPhoneNumTV
3、集合類型變量,例如數(shù)組和矢量,應(yīng)采用復(fù)數(shù)命名或使用表示該集合的名詞做后綴。
String[] mNames;
List mPetList;
4、常量命名
全部使用大寫static final int MIN_WIDTH = 4;
4、方法命名
1、方法名是一個動詞,采用大小寫混合的方式,第一個單詞的首字母小寫,其后單詞的首字母大寫;取值類可使用get前綴,設(shè)值類可使用set前綴,判斷類可使用is(has)前綴,方法里面不許出現(xiàn)0-9這樣的數(shù)字。
2、方法名字需要見名知意。
例如:initView();
3、對于方法中一定要加上適當?shù)姆强张袛啵ctry catch語句等等程序健壯性的判斷。
5、layout布局文件命名
全部小寫,采用下劃線命名法
1、contentview命名,?Activity默認布局,以去掉后綴的Activity類進行命名。不加后綴:
功能模塊.xml
activity_功能模塊.xml
例如:activity_main.xml、activity_more.xml
2、Dialog命名:dialog_描述.xml
例如:dlg_hint.xml
3、PopupWindow命名:ppw_描述.xml
例如:ppw _info.xml
4.、列表項命名listitem_描述.xml
例如:listitem_city.xml
5、包含項:include_模塊.xml
例如:include_head.xml、include_bottom.xml
6、adapter的子布局:功能模塊_item.xml
例如:main_item.xml
7、String.xml中的命名
命名模式:
activity名稱_功能模塊名稱_邏輯名稱/activity名稱_邏輯名稱/common_邏輯名稱
strings.xml中,使用activity名稱注釋,將文件內(nèi)容區(qū)分開來
二、注釋
1、類和接口注釋
在類名和接口名的頂部加入
/**
*
*@ClassName:類名
*@Description:TODO(這里用一句話描述這個類的作用)
*@author加上開發(fā)者名字開發(fā)者的郵箱地址
*@date2015-3-18 下午2:33:24開發(fā)時間
**/
2、方法注釋
/**
*@Title:方法名
*@Description:TODO(這里用一句話描述這個方法的作用)
*@param設(shè)定文件
*@returnvoid ???返回類型
*@throws
*/
3、屬性注釋
在有的屬性單詞比較不容易讓人理解的時候記得加上注釋
單行代碼注釋一律使用注釋界定符"http://"