Android开发规范和接⼝规范
AS规范
尽量使⽤最新的稳定版的 IDE 进⾏开发
编辑完 .java、.xml 等⽂件后⼀定要格式化,格式化,格式化(如果团队有公共的样式包,那就遵循它,否则统⼀使⽤ AS 默认模板即可)
删除多余的import,减少警告出现,利⽤ AS 的 Optimize Imports(Settings -> Keymap -> Optimize Imports)快捷键Ctrl+Alt+O 命名规范
代码中的命名严禁使⽤拼⾳与英⽂混合的⽅式,更不允许直接使⽤中⽂的⽅式。正确的英⽂拼写和语法可以让阅读者易于理解,避免歧义
注意:即使纯拼⾳命名⽅式也要避免采⽤。但 alibaba、taobao、youku、hangzhou 等国际通⽤的名称,可视同英⽂。
代码样式规范
使⽤标准⼤括号样式{ },左⼤括号不单独占⼀⾏,与其前⾯的代码位于同⼀⾏
函数参数的排序:最好把 Context 作为其第⼀个参数
字符串常量的命名和值
static final String PREF_EMAIL = "PREF_EMAIL";
static final String BUNDLE_AGE = "BUNDLE_AGE";
static final String ARGUMENT_USER_ID = "ARGUMENT_USER_ID";
Activities 和 Fragments 的传参:当 Activity 或 Fragment 启动需要传递参数时,那么它需要提供⼀个 public static 的函数来帮助启动或创建它
⾏长限制:代码中每⼀⾏⽂本的长度都应该不超过 100 个字符。
资源⽂件规范命名规则:类型{_模块名}_逻辑名称
版本统⼀规范
Android 开发存在着众多版本的不同,⽐如 compileSdkVersion、minSdkVersion、targetSdkVersion 以及项⽬中依赖第三⽅库的版本,不同的 module 及不同的开发⼈员都有不同的版本,所以需要⼀个
统⼀版本规范的⽂件。
如果是开发多个系统级别的应⽤,当多个应⽤同时⽤到相同的 so 库时,⼀定要确保 so 库的版本⼀致,否则可能会引发应⽤崩溃
第三⽅库规范
希望 Team 能⽤时下较新的技术,对开源库的选取,⼀般都需要选择⽐较稳定的版本。⽐如Retrofit、RxAndroid、OkHttp、Glide/Fresco、Gson/Fastjson、EventBus/AndroidEventBus、GreenDao
注释规范
类注释:每个类完成后应该有作者姓名和联系⽅式的注释,对⾃⼰的代码负责。
⽅法注释:每⼀个成员⽅法(包括⾃定义成员⽅法、覆盖⽅法、属性⽅法)的⽅法头都必须做⽅法头注释,在⽅法前⼀⾏输⼊ /** + 回车或者设置 Fix doc comment(Settings -> Keymap -> Fix doc comment)快捷键,AS 便会帮你⽣成模板,我们只需要补全参数即可android retrofit
块注释:块注释与其周围的代码在同⼀缩进级别。它们可以是 /* ... */ 风格,也可以是 // ... 风格(// 后最好带⼀个空格)。对于多⾏的 /* ... */ 注释,后续⾏必须从 * 开始,并且与前⼀⾏的 * 对齐。
其他⼀些注释:AS 已帮你集成了⼀些注释模板,我们只需要直接使⽤即可,在代码中输⼊ todo、fixme 等这些注释模板,回车后便会出现
接⼝规范
数据的整体统⼀:
根据已有的数据格式,建议返回数据统⼀为: { “status” : 1 , ”msg” : ”成功” , ”data” : ”….” } data为对应返回的数据,可以为JSON键值对中任意类型如果数据异常,status为0或其他定义的整数,msg为错误信息,data对应格式如下:
By LiYing
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论