Android开发命名规范

来源:互联网 发布:数据流程说明er图 编辑:程序博客网 时间:2024/05/18 02:29

标识符命名法
标识符命名法最要有四种:

1 驼峰(Camel)命名法:又称小驼峰命名法,除首单词外,其余所有单词的第一个字母大写。

2 帕斯卡(pascal)命名法:又称大驼峰命名法,所有单词的第一个字母大写

3 下划线命名法:单词与单词间用下划线做间隔。

4 匈牙利命名法:广泛应用于微软编程环境中,在以Pascal命名法的变量前附加小写序列说明该变量的类型。 量的取名方式为:<scope_> + <prefix_> + <qualifier>范围前缀,类型前缀,限定词。

个人觉得标识符命名原则:尽可能的用最少的字符而又能完整的表达标识符的含义。

英文缩写原则:
1 较短的单词可通过去掉“元音”形成缩写
2 较长的单词可取单词的头几个字母形成缩写
3 此外还有一些约定成俗的英文单词缩写.

下面为常见的英文单词缩写:

名称
缩写
icon  
ic (主要用在app的图标
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  包(packages): 采用反域名命名规则,全部使用小写字母。一级包名为com,二级包名为xx(可以是公司或则个人的随便),三级包名根据应用进行命名,四级包名为模块名或层级名

包名
此包中包含
com.xx.应用名称缩写.activities
页面用到的Activity (activities层级名用户界面层)
com.xx.应用名称缩写.base
页面中每个Activity类共享的可以写成一个iBaseActivity (基础共享的类)
com.xx.应用名称缩写.adapter  
页面用到的Adapter类 (适配器的类)
com.xx.应用名称缩写.tools
此包中包含:公共工具方法类tools模块名)
com.xx.应用名称缩写.bean
(或则 com.xx.应用名称缩写.unity )
此包中包含:元素类
com.xx.应用名称缩写.db
数据库操作类
com.xx.应用名称缩写.view
(或则 com.xx.应用名称缩写.ui )
自定义的View类等
com.xx.应用名称缩写.service   
Service服务
com.xx.应用名称缩写.broadcast  
Broadcast服务



2  类(classes):名词,采用大驼峰命名法,尽量避免缩写,除非该缩写是众所周知的,  比如HTML,URL,如果类名称中包含单词缩写,则单词缩写的每个字母均应大写。

描述
例如
activity 
Aty或者Activity为后缀标识
欢迎页面类WelcomeAty.或者WelcomeActivity
Adapter
  Adp或者Adapte 为后缀标识
新闻详情适配器NewtDetailAdp或则直接  NewDetailAdapter
解析类
Hlr为后缀标识
首页解析类HomePosterHlr
公共方法类
  ToolsManager为后缀标识
线程池管理类:ThreadPoolManager
           
 日志工具类:LogTools
数据库类
DBHelper后缀标识
新闻数据库:NewDBHelper
Service
Service为后缀标识
时间服务TimeService
BroadcastReceive
  以Broadcast为后缀标识
时间通知TimeBroadcast
ContentProvider  
Provider为后缀标识

直接写的共享基础类
Base开头
BaseActivity,BaseFragment

3  接口(interface):命名规则与类一样采用大驼峰命名法,多以ableible结尾,如interface Runna ble ;
                    
 interface Accessible 

4  
方法(methods):动词或动名词,采用小驼峰命名法例如:onCreate(),run()

方法
说明
initXX()
初始化相关方法,使用init为前缀标识,如初始化布局initView()
isXX()
checkXX()方法返回值为boolean型的请使用ischeck为前缀标识
getXX()
返回某个值的方法,使用get为前缀标识
processXX()
对数据进行处理的方法,尽量使用process为前缀标识
displayXX()
弹出提示框和提示信息,使用display为前缀标识
saveXX()
与保存数据相关的,使用save前缀标识
resetXX()
对数据重组的,使用reset前缀标识
clearXX()
清除数据相关的
removeXXX() 
清除数据相关的
drawXXX()
绘制数据或效果相关的,使用draw前缀标识

2 1