Android开发基本命名规范

来源:互联网 发布:php正则验证身份证 编辑:程序博客网 时间:2024/05/18 10:08

万丈高楼平地起,再高的楼如果地基不稳最终也会崩塌。
代码命名规范至关重要。


(一) 布局Layout文件命名

1. Activity View命名:activity_功能模块_子描述_子描述2.xml例如:activity_main.xml、activity_register_basicinfo.xml2. Fragment View命名:fragment_功能模块_子描述_子描述2.xml例如:fragment_main.xml、fragment_register_basicinfo.xml3. Dialog命名:dialog_功能模块_子描述.xml例如:dialog_salary_hint.xml4. PopupWindow命名:ppw_功能模块_子描述.xml例如:ppw _info.xml5.  ListView列表项命名listitem_功能模块_子描述.xml例如:listitem_city.xml6.  GridView列表项命名griditem_功能模块_子描述.xml例如griditem_city.xml7. 包含项:include_功能模块_子描述.xml       例如:include_head.xml、include_bottom.xml

(二) 布局Layout中id命名

xml中id的命名,通常需要只要本xml里面唯一就可以了,所以没有命名上的限制。整体来说,一般风格如下。1.  TextView 例如:android:id="@+id/tv_name"2. EditText 例如:android:id="@+id/et_name"3.  Button例如:android:id="@+id/btn_name"4.  ImageView 例如:android:id="@+id/iv_name"5.  LinearLayout 例如:android:id="@+id/ll_name"6.  RelativeLayout 例如:android:id="@+id/rl_name"7.  FrameLayout 例如:android:id="@+id/fl_name"8.  ListView例如:android:id="@+id/lv_name"如果项目需要拆分为多个模块,一般在子模块所有资源名称前添加子模块名。

(三) 图片资源命名

1.  静态图片 前缀_模块_描述    例如:bg_main.png、ic_main_search.png2.  动态图片 前缀_模块_描述_状态、前缀_描述_状态    例如:btn_confirm_normal、btn_confirm_selected              bg_confirm_normal、 bg_confirm_selected3.  selector文件命名 selector_模块_描述    例如:selector_account_confirm.xml4.  shape文件命名 shape_模块_描述    例如:shape_account_avatar.xml

(四) 字符串资源命名

一般只要求相关的字符串,前缀名相同即可。功能模块_类别描述_子描述<string name=" salary_menu_save">保存薪资</string>命名记得要有一定的区分度,不要取太泛的名字。例如: <string name="menu_ok ">确定</string>

(五) Activity类中控件命名

一般与资源文件里面的名字保持一致。

(六) 类名命名

命名规则:类名是个一名词,采用大小写混合的方式,每个单词的首字母大写。尽量使你的类名简洁而富于描述。使用完整单词,避免缩写词(除非该缩写词被更广泛使用,像 URL,HTML)  规约:类名必须使用驼峰规则,即首字母必须大写,如果为词组,则每个单词的首字母也必须要大写,类名必须使用名词,或名词词组。要求类名简单,不允许出现无意义的单词。如:class BookMarkAdd → 正确如:class AddBookReadPlanActivity → 错误! 应为 class BookReadPlanAdd另外,Android功能模块类名通常都要加上后缀。例如XXXActivity.java  XXXFragment.java XXXAdapter.java

(七) 类方法命名

命名规则:方法名是一个动词,采用大小写混合的方式,第一个单词的首字母小写,其后单词的首字母大写。例如: public void run(); public String getBookName();类中常用方法的命名:    1.  类的获取方法(一般具有返回值)一般要求在被访问的字段名前加上get,如    getFirstName(),getLastName()。一般来说,get前缀方法返回的是单个值,find前缀的方法返回的是列表值。    2.  类的设置方法(一般返回类型为void):被访问字段名的前面加上前缀 set,如    setFirstName(),setLastName().    3.  类的布尔型的判断方法一般要求方法名使用单词 is或has 做前缀,如isPersistent(),isString()。或者使用具有逻辑意义的单词,例如equal 或equals。    4.  类的普通方法一般采用完整的英文描述说明成员方法功能,第一个单词尽可能采用动词,首字母小写,如openFile(),addCount()。    5.  构造方法应该用递增的方式写。(参数多的写在后面)。    6.  toString()方法:一般情况下,每个类都应该定义toString()。
0 0
原创粉丝点击