代码书写规范

2017-01-17  本文已影响48人  咔咔和拉拉

res命名规范:

1.layout命名:
    1.1 以activity开头,如:
        模块名_activity_页面名.xml(特殊情况,或者页面较少,可以不用模块名)
2.fragment命名
    2.1以fragment开头, 如:
        模块名_framgent_页面名.xml(特殊情况,或者页面较少,可以不用模块名)
3.listView或者gridView的item命名:
    3.1以item开头, 如:
        模块名_item_页面名.xml(特殊情况,或者页面较少,可以不用模块名)
4.layout中id命名:
    4.1以m开头, 如:
        4.1.1 RelativeLayout m_rl_功能名
        4.1.2 TextView m_tv_功能名

src中命名规范:

1.成员变量field:
    1.1 以m开头, 之后用小驼峰规则
    1.2 对应的名字最好和layout中的id一致
        例:
            layout中的id名为:   m_tv_single_name
            src中的field命名为: mTvSingleName    (一般情况,都是自动生成的)
    1.3成员变量必须写上说明(规范命名注解除外)
    1.4成员变量的命名实例
        1.4.1成员变量命名实例,如:
            private list<MyDoctorBean> mDoctorBean;
            private MyDoctorBean[] mDoctorBeanArr;
2.参数parameter, 局部变量loacl variable
    2.1 小驼峰规则, 第一个单词首字母小写, 后面其他单词首字母大写, 如:
        strPrice

习惯命名:

1.方法命名:
    1.1动词或者动名词开头
    1.2如:
        onCreate();
        initView();
        getData();
        doPost();
        removeData();等等
2.类名:
    2.1大驼峰,每个单词的第一个首字母大写
    2.2如:   
        GoodsDetailActivity
        FirstPageFragment
    2.3接口名:
        2.3.1大写I开头的双大写字母开头
        2.3.2如:IUpdate
    2.4包名命名:
        2.4.1 统一开头以后, 具体一般分base,details,utils,view几块
            2.4.1.1 base 一些detail中会继承到一些父类
            2.4.1.2 detail 具体的ui类
                2.4.1.2.1 一般分为【detail.具体模块】的子包名
                2.4.1.2.2 如:
                    xxx.xxx.mine;
                    xxx.xxx.detail.more;
                    xxx.xxx.detail.first;等子模块
            2.4.1.3 具体如果有adapter,fragment等分类,也可以在子模块下面建立子包名
            2.4.1.4 如:xxx.xxxdetail.first.adapter;
            2.4.1.5 utils 一些工具类(一般封装好, 大家一起使用)
            2.4.1.6 view 特殊的view和自定义view
上一篇 下一篇

猜你喜欢

热点阅读