開發規範

類型 規則 例子 備註
包名(只能使用小寫字母和.) 頂級包名 類型+公司/組織+項目 org.aaa.bbb 其中org代表肥盈利性,aaa代表公司或組織,bbb代表項目
模塊 類型+公司/組織+項目+模塊 org.aaa.bbb.usercenter usercenter代表用戶中心這個模塊
類名(大駝峯法且只用字母和數字) 從android SDK中派生出來的子類 功能+父類類名的縮寫/全稱 public class GoodsFragment extends YBaseFragment{}
其中Goods表示是商品頁面,Fragment表示集成只android的Fragment類
與xml中include標籤對應的可重用的/子佈局的類 功能+Layout GoodsSpecLayout,其中GoodsSpec表示該佈局是商品規格,
Layout是固定的後綴表示是該佈局是一個可以被複用的子佈局
bean包下的類 功能+Bean
service包下的類 統一隻放服務的接口,並全部以Service爲後綴 public interface ConfigService {}
service.impl包下的類 統一隻放服務的具體實現類,並全部以ServiceImpl爲後綴 public class ConfigServiceImpl implements ConfigService {}
變量 從view派生出來的ui控件 與xml中的id名稱保持一致 private TextView tvGoodsCate4Title;對應<TextViewandroid:id="@+id/tvGoodsCate4Title"/>
非從view派生出來的ui控件 小駝峯法 private String mGoodsId;
函數 小駝峯法 public void onCreate(Bundle savedInstanceState){}
常量 固定爲static final,不使用final static;只使用大寫字母、數值和_ private static final int GOODS_CATE_LEVEL3 = 3;
資源(文件名稱只能使用小寫字母、數字和_) anim   具體使用該動畫的頁面的類名縮寫+動畫功能 GoodsDetailActivity中顯示商品評價記錄佈局的一個入場動畫命gda_comment_in,其中gda是GoodsDetailActivity的縮寫(所有單詞的首字母組合),comment_in表示是評論記錄的入場動畫
drawable 圖片 圖片的特徵
      是一個加號圖標命名爲ic_add,
      其中ic表示是小圖標,add表示是增加
shape shape+控件id的變種 shape_tv_goods表示商品文本的背景
selector selector+控件id的變種 selector_tv_goods表示商品文本的背景
layout 佈局中控件的id 使用小駝峯命名方式,控件類型縮寫+功能 <Button android:id="@+id/btnBack"/>
其中btn是Button的縮寫,Back是代表該按鈕的功能是返回
從android SDK中派生出來的子類 類名後綴前置 GoodsDetailActivity類對應的佈局命名爲activity_goods_detail
與xml中include標籤對應的可重用的/子佈局的類 layout後綴前置 GoodsSpecLayout類對應的佈局命名爲layout_goods_spec
所有從dialog派生出來的子類 dialog+功能 退出應用的dialog命名爲dialog_exit_app
ListView,GirdView等的項 item+控件類型縮寫+功能 商品評論列表中的項命名爲item_lv_goods_comment
values strings 具體使用該sting的頁面的類名縮寫+控件id變種+類型 <string name="fpa_tv_new_psw_text">新密碼:</string>
<string name="fpa_et_new_psw_hint">請輸入新密碼</string>
其中fpa是頁面ForgetPswActivity的縮寫,tv和et是TextView和EditText控件的縮寫,
text和hint分別表示文本和提示文本
styles 具體使用該sting的頁面的類名縮寫+控件id變種+類型 <style name="pdgda_tv_num">
    <item name="android:layout_width">wrap_content</item>
    <item name="android:layout_height">wrap_content</item>
</style>
colors 具體使用該sting的頁面的類名縮寫+控件id變種+類型 <color name="gda_tv_num_bg">#5e5e5b5b</color>
<color name="gda_tv_num_text">#5e5e5b5b</color>
其中gda是頁面的縮寫,tv_num控件id(tvNum)的變種,bg代表背景色,text代表文本色
dimens 具體使用該sting的頁面的類名縮寫+控件id變種+類型 <dimen name="gda_ll_order_record_right_w">440dp</dimen>
其中gda是頁面的縮寫,ll_order_record_right控件id(llOrderRecordRight)的變種,w代表寬度
註釋 單行註釋,主要用於描述代碼邏輯 位於被註釋代碼的右邊  int goodsCateSize   6;//一級商品分類的數量(不包括默認額)
多行註釋,主要用於描述類的功能和其他基本信息、描述函數的功能、成員變量的用處 位於被註釋代碼的上邊 /**
 * 應用顯示的高度
 */
public static int DISPLAY_HEIGHT = -1;

/**
 * 在電商端登錄
 *
 * @param context 發送請求的上下文
 * @param handler 回調
 */
public RequestHandle ShopLogin(Context context, BaseJsonHttpHandler handler){}

/**
 * Description:登錄的接口,使用持久化的cookies來保存登錄狀態
 * User: Caizemingg(Email:[email protected])
 * Date: 2014-12-10
 * Time: 19:11
 * ModifyDescri:
 * ModifyDate:
 */
public interface AccountService {}
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章