先初略介绍下当前主要的标识符命名法和英文缩写规则:(这段别人那边借鉴的)
在讲解命名规范前,先初略介绍下当前主要的标识符命名法和英文缩写规则。
标识符命名法
标识符命名法最要有四种:
1 驼峰(Camel)命名法:又称小驼峰命名法,除首单词外,其余所有单词的第一个字母大写。
2 帕斯卡(pascal)命名法:又称大驼峰命名法,所有单词的第一个字母大写
3 下划线命名法:单词与单词间用下划线做间隔。
4 匈牙利命名法:广泛应用于微软编程环境中,在以Pascal命名法的变量前附加小写序列说明该变量的类型。
个人觉得标识符命名原则:尽可能的用最少的字符而又能完整的表达标识符的含义。
英文缩写原则:
1 较短的单词可通过去掉“元音”形成缩写
2 较长的单词可取单词的头几个字母形成缩写
3 此外还有一些约定成俗的英文单词缩写.
下面为常见的英文单词缩写:
名称 | 缩写 |
icon | ic |
color | cl(主要用于颜色值) |
divider | di(主要用于分隔线,不仅包括Listview中的divider,还包括普通布局中的线) |
selector | sl(主要用于某一view多种状态,不仅包括Listview中的selector,还包括按钮的selector) |
average | avg |
background | Bg(主要用于布局和子布局的背景) |
buffer | buf |
control | ctrl |
delete | del |
document | doc |
error | err |
escape | esc |
increment | inc |
infomation | info |
initial | init |
image | img |
Internationalization | I18N |
length | len |
library | lib |
message | msg |
password- | pwd |
position | pos |
server | srv |
string | str |
temp | tmp |
window | wnd(win) |
程序中使用单词缩写原则:不要用缩写,除非该缩写是约定俗成的。
命名规范:
1
包名 | 此包中包含 |
com.xx.应用名称缩写.activities | |
| |
com.xx.应用名称缩写.adapter | |
com.xx.应用名称缩写.tools | |
com.xx.应用名称缩写.bean (或则 | |
com.xx.应用名称缩写.db | |
com.xx.应用名称缩写.view (或则 | |
com.xx.应用名称缩写.service | |
com.xx.应用名称缩写.broadcast | |
2
类 | 描述 | 例如 |
activity | | |
Adapter类 | | |
解析类 | | |
公共方法类 | | |
数据库类 | | |
Service类 | | |
BroadcastReceive类 | | |
ContentProvider | | |
直接写的共享基础类 | | BaseActivity,BaseFragment |
3
4
方法 | 说明 |
initXX() | |
isXX() | |
getXX() | |
processXX() | |
displayXX() | |
saveXX() | |
resetXX() | |
clearXX() | |
removeXXX() | |
drawXXX() | |
5
用统一的量词通过在结尾处放置一个量词,就可创建更加统一的变量,它们更容易理解,也更容易搜索。例如,请使用 strCustomerFirst 和 strCustomerLast ,而不要使用 strFirstCustomer 和 strLastCustomer 。
量词列表:量词后缀说明
First
Last
Next
Prev
Cur
6
7
命名模式:activity名称_逻辑名称/common_逻辑名称
如果有多种形态如按钮等除外如btn_xx.xml(selector)
名称 | 功能 |
btn_xx | |
btn_xx_normal | |
btn_xx_press | |
bg_head | |
def_search_cell | |
icon_more_help | |
seg_list_line | |
sel_ok | |
命名后缀:
后缀 | 说明 |
unit | |
nor | |
hl | |
press | |
select | |
unselect | |
8
1).contentview命名,
2).Dialog命名:dialog_描述.xml
2).PopupWindow命名:ppw_描述.xml
3).
4).包含项:include_模块.xml
5).adapter的子布局:功能模块_item.xml
9
//前面为动画的类型,后面为方向
动画命名例子 | 规范写法 | 备注 |
fade_in | 淡入 | |
fade_out | 淡出 | |
push_down_in | 从下方推入 | |
push_down_out | 从下方推出 | |
push_left | 推像左方 | |
slide_in_from_top | 从头部滑动进入 | |
zoom_enter | 变形进入 | |
slide_in | 滑动进入 | |
shrink_to_middle | 中间缩小 | |
10
命名模式:activity名称_功能模块名称_逻辑名称/activity名称_逻辑名称/common_逻辑名称
strings.xml中,使用activity名称注释,将文件内容区分开来
11
命名模式为:view缩写_模块名称_view的逻辑名称
view的缩写详情如下:
控件 | 缩写 |
LayoutView | lv |
RelativeView | rv |
TextView | tv |
Button | btn |
ImageButton | imgBtn |
ImageView | mgView 或则 iv |
CheckBox | chk |
RadioButton | rdoBtn |
analogClock | anaClk |
DigtalClock | dgtClk |
DatePicker | dtPk |
EditText | edtTxt |
TimePicker | tmPk |
toggleButton | tglBtn |
ProgressBar | proBar |
SeekBar | skBar |
AutoCompleteTextView | autoTxt |
ZoomControls | zmCtl |
VideoView | vdoVi |
WdbView | webVi |
RantingBar | ratBar |
Tab | tab |
Spinner | spn |
Chronometer | cmt |
ScollView | sclVi |
TextSwitch | txtSwt |
ImageSwitch | imgSwt |
listView | lVi 或则lv |
ExpandableList | epdLt |
MapView | mapVi |
12.activity中的view变量命名
命名模式为:逻辑名称+view缩写
建议:如果layout文件很复杂,建议将layout分成多个模块,每个模块定义一个moduleViewHolder,其成员变量包含所属view
13.styles.xml:将layout中不断重现的style提炼出通用的style通用组件,放到styles.xml中;
14.使用layer-list和selector
Android编码规范建议(别人弄的觉得蛮有道理)
1.java代码中不出现中文,最多注释中可以出现中文
2.局部变量命名、静态成员变量命名
只能包含字母,单词首字母除第一个外,都为大写,其他字母都为小写
3.常量命名
只能包含字母和_,字母全部大写,单词之间用_隔开
4.图片尽量分拆成多个可重用的图片
5.服务端可以实现的,就不要放在客户端
6.引用第三方库要慎重,避免应用大容量的第三方库,导致客户端包非常大
7.处理应用全局异常和错误,将错误以邮件的形式发送给服务端
8.图片的.9处理
9.使用静态变量方式实现界面间共享要慎重
10.Log(系统名称模块名称接口名称,详细描述)
11.单元测试(逻辑测试、界面测试)
12.不要重用父类的handler,对应一个类的handler也不应该让其子类用到,否则会导致message.what冲突
13.activity中在一个View.OnClickListener中处理所有的逻辑
14.strings.xml中使用%1$s实现字符串的通配
15.如果多个Activity中包含共同的UI处理,那么可以提炼一个CommonActivity,把通用部分叫由它来处理,其他activity只要继承它即可
16.使用button+activitgroup实现tab效果时,使用Button.setSelected(true),确保按钮处于选择状态,并使activitygroup的当前activity与该button对应
17.如果所开发的为通用组件,为避免冲突,将drawable/layout/menu/values目录下的文件名增加前缀
18.数据一定要效验,例如
字符型转数字型,如果转换失败一定要有缺省值;
服务端响应数据是否有效判断