Android开发规范——命名

在讲解命名规范前，先初略介绍下当前主要的标识符命名法和英文缩写规则。

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

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

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

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

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

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

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

下面为常见的英文单词缩写:
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，二
级包名为anjoyo，三级包名根据应用进行命名，四级包名为模块名或层级名


例如：
com.anjoyo.应用.activities      此包中包含：页面用到的Activity类 (activities层级名 用户界面层)
com.anjoyo.应用.tools      此包中包含：公共工具方法类 （tools 模块名）
com.anjoyo.应用.db      此包中包含：数据库操作类
com.anjoyo.应用.custom      此包中包含：自定义的View类等
com.anjoyo.应用.service      此包中包含：Service服务
com.anjoyo.应用.broadcast      此包中包含：Broadcast服务

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

activity 类     Aty为后缀标识，如欢迎页面类WelcomeAty.
Adapter类       Adp为后缀标识,如商品详情适配器ProductDetailAdp
解析类             Hlr为后缀标识，如首页解析类HomePosterHlr
公共方法类   Tools或Manager为后缀标识。如：线程池管理类：ThreadPoolManager
                       日志工具类：LogTools
数据库类       以DBHelper后缀标识。如城市数据库：CityDBHelper
Service类     以Service为后缀标识
BroadcastReceive   以Broadcast为后缀标识
ContentProvider     以Provider为后缀标识

3 接口（interface）：命名规则与类一样采用大驼峰命名法，多以able或ible结尾，如interface Runn a   ble  ;
                                         interface Access ible  。

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

initXXX()      初始化相关方法,使用init为前缀标识
isXXX()           checkXXX() 方法返回值为boolean型的请使用is或check为前缀标识
getXXX()         返回某个值的方法，使用get为前缀标识
processXXX() 对数据进行处理的方法，尽量使用process为前缀标识
displayXXX() 弹出提示框和提示信息，使用display为前缀标识
saveXXX()       与保存数据相关的，使用sav为e前缀标识
resetXXX()     对数据重组的，使用reset前缀标识
clearXXX()removeXXX()   清除数据相关的，使用clear或remove为前缀标识
drawXXX()         绘制数据或效果相关的，使用draw前缀标识

5 变量（variables）采用小驼峰命名法。类中控件名称必须与xml布局id保持一致。

1 View变量命名：控件类型描述 +　意义描述
控件                      缩写
TextView                     txt
Button                         btn
ImageButton               imgBtn
ImageView                   imgView
CheckBox                     chk
RadioButton               rdoBtn
analogClock               anaClk
DigtalClock               dgtClk
DatePicker                 dtPk
TimePicker             tmPk
toggleButton          tglBtn
EditText                edtTxt
ProgressBar   proBar    proBar
SeekBar                              skBar
AutoCompleteTextView autoTxt
ZoomControls             zmCtl
Include                       ind
VideoView                   vdoVi
WdbView                       webVi
RantingBar                 ratBar
Tab                               tab
Spinner                       spn
Chronometer               cmt
ScollView                   sclVi
TextSwitch                 txtSwt
ImageSwitch               imgSwt
listView                     lVi
ExpandableList         epdLt
MapView                       mapVi

用统一的量词通过在结尾处放置一个量词，就可创建更加统一的变量，它们更容易理解，也更容易搜索。例如，请使用strCustomerFirst和strCustomerLast，而不要使用strFirstCustomer和strLastCustomer。
量词列表：量词后缀说明
First   一组变量中的第一个
Last     一组变量中的最后一个
Next     一组变量中的下一个变量
Prev     一组变量中的上一个
Cur       一组变量中的当前变量
 
6 常量（constants）全部大写,采用下划线命名法.例如：MIN_WIDTH

7 XML文件（布局文件）：全部小写，采用下划线命名法
   1．Activity默认布局，以去掉后缀的Activity类进行命名。不加后缀
   2．Activity子布局，父布局名称开始，追加item 和子布局功能说明。
例如：Activity默认布局：homeposter.xml     子布局为homeposter_item_poster.xml

8 资源文件（图片）： 全部小写，采用下划线命名法，加前缀区分

btn_login_normal	按钮图片使用btn_功能_说明
bg_head	背景图片使用bg_功能_说明
def_search_cell	默认图片使用def_功能_说明
icon_more_help	图标图片使用icon_功能_说明
seg_list_line	具有分隔特征的图片使用seg_功能_说明
sel_ok	选择图标使用sel_功能_说明

9   动画文件（anim包）：全部小写，采用下划线命名法，加前缀区分。

 

动画命名例子	规范写法	备注
click_head_left	点击背景切换动画使用click前缀标识
bg_shape_rectangle	背景自定义图形使用bg前缀标识
show_shopcar_add	小动画效果使用show前缀标识

10     资源ID（resources id）：大小写规范与方法名一致，采用小驼峰命名法。命名规范为“资源控件的缩写  名”+“变量名”。注意：页面控件名称应该和控件id名保持一致

酒少爷

注意事项：
1.项目编码格式统一采用UTF-8编码
2.代码中除注释外禁止出现中文
3.文件禁止出现警告提示 例如：
4.项目文件禁止出现警告提示 例如：
5.在项目中创建libs文件夹，统一放置引用的外部jar文件。引用第三方库的时候要谨慎，避免使用大容量的第三方库，而导致客户端非常大
6.在项目中，res文件夹中创建animation文件夹，统一放置动画xml文件
7.在项目中，res文件夹中创建drawable文件夹，统一放置selector.xml，shape.xml等配置文件
8.服务端可以实现的，就不要放在客户端来实现
9.strings.xml中使用%1$s实现字符串的通配 
10.如果多个Activity中包含共同的UI处理，那么可以提炼一个CommonActivity，把通用部分叫由它来处理，其他activity只要继承它即可 
11.使用button+activitgroup实现tab效果时，使用Button.setSelected(true)，确保按钮处于选择状态，并使activitygroup的当前activity与该button对应 
12.数据一定要效验，例如
字符型转数字型，如果转换失败一定要有缺省值；
服务端响应数据是否有效判断  
13.图片的.9处理，图片要压缩
14.不要重用父类的handler，对应一个类的handler也不应该让其子类用到，否则会导致message.what冲突 
15.资源文件只能以小写字母和下划线做首字母，随后的名字中只能出现 [a-z0-9_.] ,否
则会导致R文件无法自动生成
16.onCreate中完成控件的初始化，onResume中完成数据的准备
17.每个activity都有自己独立的消息处理，其中包括正确的消息处理，错误处理，异常捕捉
18.任何主线程不需要做过于复杂的处理，并且主线程需要提供一个Handler给子线程去返回完成信息
19.每个项目开始前应进行分析和命名文档的编写


缩写：
bg----------background
txt----------textview
img----------imageview
btn----------button
txt----------textview
pic----------picture
lv----------listview
vp----------viewpager
gv----------gridview

6.方法参数命名：
参数的命名规范和方法的命名规范相同，而且为了避免阅读程序时造成迷惑，请在尽量保证参数名称为一个单词的情况下使参数的命名尽可能明确。 
7.图片资源命名：必须具有实际意义的英文单词或英文单词组合，如果图片为共享性图片资源，命名在前者的基础上加上share_(命名应与代码<布局文件>中标识变量名称的英文单词<id>相一致）
8.Log使用：(系统名称 模块名称 接口名称，详细描述）
9.values中配置文件的命名规范：
  values应包含：colors,strings,styles,arrays
目录结构：
        /values
              /arrays（展示信息）
              /colors（颜色代码）
              /strings（信息描述）
              /styles（属性风格）
10.布局文件的命名规则：
   模块名+具有实际意义的英文单词或英文单词组合（每个英文单词用下划线_分割）
   例如：main_login.xml
11.布局文件中id的命名规则：
   控件属性+实际activity的英文标识单词+实际变量的英文表示单词 （用下划线_隔开）
   例如：img_main_back

http://blog.sina.com.cn/s/blog_3f5dd7810101j4u2.html