Android Code Style

发表于 2016-02-14 更新于 2023-01-05 分类于 Android 阅读次数： Valine：

形成隐喻，提高效率

1. 约定

Activity.onCreate()，Fragment.onActivityCreated()，紧跟成员变量后，方法内部保持简单，尽量只调用initXXX()方法，如：initData()，initView()。
调用方法保持“临近原则”，被调用的方法，放在调用方法下方
单个方法体不要过长
代码任何地方不要拼错单词
统一调整IDE的Tab缩进为4个空格
杜绝整个类代码格式化
提交代码使用中文注释，如果解决bug加上#bug号，如**#123，解决问题描述，不要写fix bug无意义描述**

规则：使用**驼峰命名，前缀+逻辑名称**，不需要下划线分割

注：id对应的成员变量，使用Android BufferKnift Zelezny插件生成，变量前自动加“m前缀”

规则： 使用**lf_前缀_逻辑名称**命名，单词全部小写，单词间以_分割。

规则： 使用 lf_前缀_用途 命名，单词全部小写，单词间以下划线分割。

必须携带第三方资源前缀
umeng_socialize_style.xml
pull_refresh_attrs.xml

规则： 使用**驼峰规则，首字母必须大写**，使用名词或名词词组。要求简单易懂，富于描述，不允许出现无意义或错误单词。

规则： 使用**驼峰规则，首字母必须小写**，使用动词。要求简单易懂，富于描述，不允许出现无意义或错误单词。

规则： 使用**驼峰规则，首字母必须小写**，使用名词或名词词组。要求简单易懂，富于描述，不允许出现无意义或错误单词。

Activity继承BaseFragmentActivity或SwipeBackActivity，可以使用ButterKnife注解代替findViewById
方法
- 拆分臃肿方法，每个方法只作一件事
- 做同一个逻辑的方法，尽量靠近放到一块，方便查看
- 不要使用 try catch 处理业务逻辑
- 使用JSON工具类，不要手动解析和拼装数据
控制语句
- 减少条件嵌套，不要超过3层
- if判断使用“卫语句”，减少层级
  if(obj != null) { doSomething(); }
  修改为：
  if(obj == null) { return; } doSomething();
- if语句必须用{}包括起来,即便是只有一句
处理“魔数”等看不懂的神秘数字
- 代码中不要出现数字，特别是一些标识不同类型的数字。
- 所有意义数字全部抽取到Constant公共类中，避免散布在各位类中。
空行：空行将逻辑相关代码段隔开，简洁清楚，提高可读性
- 成员变量之间，根据业务形成分组加空行
- 方法之间加空行
用好TODO标记
- 记录想法，记录功能点，开发过程中可以利用TODO记录一下临时想法或为了不打扰思路留下待完善的说明
- 删除无用TODO，开发工具自动生成的TODO，或则已经完善的TODO，一定要删除。