• 1.拟定代码规范的文档
  • 2.通过静态代码检测工具进行代码检测,进而完善文档
  • 3.通过代码审查,团队沟通,进而完善文档

代码规范

《Java开发手册(黄山版)》
《阿里巴巴Android开发手册》

1.命名规范

所有编程相关命名不能以下划线或者美元符号开头

1.1 包命名

小写 反域名

com.xxx.xxx
1.2 UI组件命名

xml中用下划线区分 源代码中用驼峰的形式

Viewxmlcode
TextViewtv_xxtvXx
Buttonbtn_xxbtnXx
EditTextet_xxetXx
RecyclerViewrv_xxrvXx
1.3 成员变量

可以加上m的前缀

val mStr = "Android"

fun setStr(str:String){
   mStr = str
}

加上前缀可以更好的区分成员变量和局部变量,特别是传值的场景

代码检测

1.代码检测插件

插件名简介推荐
LintAndroid Studio 自带功能强大的代码检测工具必备
Ali-Check阿里出品Java代码检测工具有java代码的旧项目
SonarLint支持多种代码检测推荐
CheckStyle侧重于检测代码风格,支持定制
DeteKtkotlin代码检测工具kotlin项目推荐
Logo

瓜分20万奖金 获得内推名额 丰厚实物奖励 易参与易上手

更多推荐