文档介绍：该【安卓开发规范 】是由【guoxiachuanyue002】上传分享，文档一共【9】页，该文档可以免费在线阅读，需要了解更多关于【安卓开发规范 】的内容，可以使用淘豆网的站内搜索功能，选择自己适合的文档，以下文字是截取该文章内的部分文字，如需要获得完整电子版，请下载此文档到您的设备，方便您编辑和打印。安卓开发规范
编写目的
为了使项目文档组织有序,方便项目组成员协调开发工作,便于后期开发人员理解和维护代码,公司的android开发项目应该有一套命名规范,小组人员在编写代码时应该遵循这些规范,使用有意义的字符书写代码中得类型、变量,形成良好的编码风格。
简单描述
工程文件编码格式:UTF-8
包结构
3・1・src的目录结构
.:±tli1tuid宜匚ty
:iPP
const;辽Lt
咼強熾®-®-:®-®-®-:©-®-®-:®-
entity
service
widget
・com・hy・prss・mobile・android・constant
例如:
描述:包下的所有类里只能装常量,常量格式publicstaticfinalxxxXXX=xxx;
,定义在常量包里方便调用
・2・com・hy・prss・mobile・android・widget
例如::包下的所有类里只能是自定义控件或自定义dialog
3・1・3・com・hy・prss・mobile・android・entity
例如:
描述:包下的所有类里只能是属性变量+get和set方法
3・1・4・com・hy・prss・mobile・android・activity
例如:
MyActivity是所有的Activity的父类,对Activity的统一的处理在MyActivity实现,如:对顶部标题栏的显示和底部标题栏的显示
Activity的作用:加载layout,初始化控件,设置监听,处理监听事件描述:所有活动的集合
3・1・5・com・hy・prss・mobile・android・service
例如:
描述:业务层
3・1・6・com・hy・prss・mobile・android・dao
例如:
描述:数据访问
3・1・7・com・hy・prss・mobile・android・util
例如:
描述:所有的零碎功能
包括处理XmlUtil,JsonUtil,SharedPreferencesUtil,DBUtil,FileUtil,HttpUtil,SocketUtil,StringUtil,DeviceUtil
・com・hy・prss・mobile・android・app
例如::
存放Broadcast,service,application所有的Service继承MyService服务:
•用在不需要界面时,还需要长时间在后台运行的地方广播:
•用来接收系统
•广播用于处理后台服务与前台界面的交互
3・1・9・com・hy・prss・mobile・android・test
例如:
描述:
junittest模块测试
32values的目录结构
白…values
:±
弓trings,xml1246styles,xml85405
4・1・java代码命名规范
4・1・1•类名、接口命名规则
类和接口的名称应该是一个名词,与设计文档保持一致;
采用大小写混和的方式,每个单词的首字母大写;
命名使用完整单词,禁止使用中文全拼,如使用缩写词必须添加注释(除非该缩写词被广泛的使用,如URL、HTML);
4・1・1・1・例如
classUserTest;//各单词首字母大写
interfaceIUserTest;//接口以大写I开头
abstractclassAbsUserTest;//抽象类以Abs开头
4・1・2•方法函数命名规则
方法名应该是动词/动名词,采用大小写混和方式,第一个单词首字母小写,其后单词的首字线大写。
4・1・2・1・例如
run()
runFase()
•变量命名规则
变量命名采用大小写混和的方式,第一个单词首字母小写,其后单词的首字母大写。变量名应简短有意义;
尽量避免单个字符的变量名(临时变量除外);
所有变量要显式的赋值;
静态变量命名采用全大写字母,中间用下划线分隔。
4・1・3・1・
例如
inttotal=0;
Stringname=null;
ButtonbnStart二newButton。;staticintMAX_CODE_LINE=200;
4・2■资源文件代码命名规范
•命名文件名
因为该文件名不识别大写字符,所有单词间以下划线分割例如:activity_main
422•命名内部属性名
参考变量命名规则
例如:
bnStart
styleDialog
4・2・2・1・widget缩写对应表
因为widget比较常用所以特用缩写代替
缩写对应如下:
TextView
tv
EditText
et
WebView
wv
ImageView
iv
VideoView
vv
MediaController
mc
ListView
lv
GridView
gv
Gallery
gly
Button
btn
ImageButton
ib
CheckBox
cb
RadioButton
rb
SeekBar
sb
ProgressBar
Pb
Spinner
spr
SearchView
sv
AnalogClock
ac
TimePicker
tp
DatePicker
dp
5・1■生成api的方法
选择工程,鼠标右键菜单Export,选择Java下面的Javadoc,点”next”按钮
,如:C:\ProgramFiles\Java\\bin\
选择生成到Javadoc文档中的内容(一般选public或protected),选存放目录(默认即可),next下一步,此页全默认即可,再next下一步。
如果项目采用的是UTF—8的编码,一定要在这一页的Extra
Javadocoptions中加”-encodingUTF-8-charsetUTF-8〃。否则生成的网页中文注释都是乱码。点Finish完成
所有的代码注释都会被自动加入api中,所以为了让他人看懂所写代码,在编写程序代码的时候尽量加全所有可以被加入到api中的注释
•设置方法
设置注释模板的入口:Window->Preference->Java->CodeStyle->CodeTemplate然后展开Comments节点,对个个节点进行设
置
522•类说明注释
该注释一般位于package/import语句之前,class描述之前。要求至少写出内容说明、创建者、创建时间和特别注意事项等内容。
5・2・2・1・例如
/**
*对类的说明
***@author张三
***@time${date}${time}
***@version
*/
523•方法说明注释
对每个方法都应有适当的说明,位于方法声明之前,包括:说明、参数说明、异常说明、返回值说明和特别说明等
5・2・3・1・例如
/**
*对方法的说明
***@paramid查询用ID
***@returnUser实体类
*/
•方法体内代码的注释
5・2・4・1・块的注释
/*****************^说明******************/
5・2・
//说明
5・2・
/*
*说明1
*说明2
*/
5・2・4・4・例如
/*****************是否是超级管理员******************/PrivateBooleanisAdmin=false;
/*
isAdmin==true处理
false不处理
*/
If(isAdmin){
//设置用户id
userId=“111”;
}
5・3■资源文件代码注释
5・3・1•块的注释
<!—说明一>
〈skip/>
5・3・2•变量注释
<!--说明一>