Skip to content
This repository has been archived by the owner on Sep 22, 2018. It is now read-only.

Coding Style

Harry Chen edited this page Sep 1, 2014 · 3 revisions

BlackLight对本项目中的代码风格作如下规定.

Java

  1. 使用 TAB 来对齐代码,每级缩进使用一个 TAB
  2. 非静态成员用 m 开头,静态非常量成员用 s 开头,常量尽量全部大写
  3. 类名尽量使用 功能+类型 的模式,除了 Utility 这种杂项类以外
  4. 尽量少出现单行语句过长的情况
  5. (为了优化)尽量少用需要重复实例化的匿名内部类
  6. 尽量做到代码的可重用,少出现重复代码
  7. 函数名尽量符合语法,以便阅读
  8. 如果要使用调试log输出,请引入 BuildConfig.DEBUG 并用if语句判断DEBUG为true时输出调试日志。
  9. 如果有多个重复类型的成员,只定义一次类型即可,尽量用 TAB 对齐等号

XML

  1. TAB !!!!!!!!!!!!!!!!!
  2. 过长的xml尽量分成多个并使用 \<include\> 引入
  3. 自定义style使用 My 开头,以 . 分割单词,首字母全部大写,例如 My.Theme.Holo.Light.DarkActionBar
  4. 资源名称全部使用英文小写,用下划线分隔单词,使用有意义的名称
  5. 修改主题时应同时提供夜间模式主题版本
  6. 需要复用的ID请单独定义
  7. 定义string时请注意 分类注释

Makefile

  1. TAB 对齐变量的赋值号
  2. \ 来分割带有多项的列表,尽量一行一项
  3. 添加了lib时千万别忘了修改Makefile,无论你在哪一个分支

其他

未提及部分参照Android代码风格指导

Clone this wiki locally