- 1.拟定代码规范的文档
- 2.通过静态代码检测工具进行代码检测,进而完善文档
- 3.通过代码审查,团队沟通,进而完善文档
代码规范
《Java开发手册(黄山版)》
《阿里巴巴Android开发手册》
1.命名规范
所有编程相关命名不能以下划线或者美元符号开头
1.1 包命名
小写
反域名
com.xxx.xxx
1.2 UI组件命名
xml中用下划线区分
源代码中用驼峰的形式
View | xml | code |
---|---|---|
TextView | tv_xx | tvXx |
Button | btn_xx | btnXx |
EditText | et_xx | etXx |
RecyclerView | rv_xx | rvXx |
1.3 成员变量
可以加上m的前缀
val mStr = "Android"
fun setStr(str:String){
mStr = str
}
加上前缀可以更好的区分成员变量和局部变量,特别是传值的场景
代码检测
1.代码检测插件
插件名 | 简介 | 推荐 |
---|---|---|
Lint | Android Studio 自带功能强大的代码检测工具 | 必备 |
Ali-Check | 阿里出品Java代码检测工具 | 有java代码的旧项目 |
SonarLint | 支持多种代码检测 | 推荐 |
CheckStyle | 侧重于检测代码风格,支持定制 | |
DeteKt | kotlin代码检测工具 | kotlin项目推荐 |