android书写规范说明.docx

书写规范说明
1、简介

术语或缩写词
说明性定义
JavaDoc
来自Sun 微系统用于生成API 文档为来自Java 源代码的HTML 格式的一种计算机软件工具。
9Patch
NinePatchDrawable 绘画的是一个可以伸缩的位图图像,Android会自动调整大小来容纳显示的内容。
2、编码规范

代码内的空行、缩进、对齐、换行、。。
Eclipse中配置方式:

类别
说明
例子
包
包名一律小写, 少用缩写和长名;采用以下规则:[com].[组织名].[项目名] 后面再跟后面为模块名或层级名称。
..
..
类
类或接口名是个一名词,采用大小写混合的方式,每个单词的首字母大写。尽量使你的类名简洁而富于描述。使用完整单词,避免用缩写词(除非该缩写词被更广泛使用,像URL,HTML)
如:
interface OnResultListener
class Result
方法
方法名是动词[名词]结构,采用大小写混合的方式,第一个单词的首字母小写,其后单词的首字母大写;取值类可使用get前缀,设值类可使用set前缀,判断类可使用is(has)前缀。
如:
essful()
essful()
变量
只在代码块的开始处声明变量;
采用大小写混合的方式,第一个单词的首字母小写,其后单词的首字母大写;
如:String bookName
变量名不应以下划线或美元符号开头;
尽量避免单个字符的变量名;
组件或部件变量使用其类型名或类型名缩写作其后缀。;
集合类型变量,例如数组和矢量,应采用复数命名或使用表示该集合的名词做后缀。
成员变量
使用m开头,其它和变量的规则一致,
如:boolean essful
临时变量
临时变量通常被取名为i,j,k,m和n,它们一般用于整型;c,d,e,它们一般用于字符型。
如: for (int i=0;i<iLen;i++)
常量
全部采用大写,单词间用下划线隔开
Static final String MSG_GATEWAY_NOT_RESPONSE;

类别
说明(前缀)
例子
LinearLayout
lay
layFriend
RelativeLayout
lay
layMsg
FrameLayout
lay
layCart
TableLayout
lay
layTab
Button
btn
btnHome
ImageButton
ibtn
ibtnPlay
TextView
tv
tvName
EditText
et
etName
ListView
lv
lvCart
ImageView
iv
ivHead
GridView
gv
gvPhoto

类别
说明
例子
layout文件
必须以全部单词小写,单词间以下划线分割,使用名词或名词词组。用common前缀表示多模块共用布局,用inc前缀表示嵌入布局。采用以下规则:
模块名_逻辑名称
act_逻辑名称
common_逻辑名称
inc_逻辑名称
act_friend







drawable
全部单词小写,单词间以下划线分割。使用名词或名词词组,可加后缀_s表示小图_b表示大图,逻辑名称可由多个单词加下划线组成,采用以下规则:
模块名_用途_逻辑名称
模块名_用途_颜色
用途_逻辑名称
用途_颜色
Icon-写死的,图标
Bg-图片背景等
Btn-按钮图片
按键






输入框背景
白色分割线
anim
全部单词小写,单词间以下划线分割,采用以下规则:
模块名_逻辑名称
逻辑名称