└── README.md /README.md: -------------------------------------------------------------------------------- 1 | 2 | 安居客Android开发规范V1.0(2013-06-27) 3 | ========================================= 4 | 1. 规范的规范 5 | ------------------------ 6 | * **本规范的每一条目必须无二义性，并且可执行。否则作废** 7 | * **本规范的条目分为两个级别:** 8 | + **规则（加粗文字）** 9 | + 建议（普通文字） 10 | * **本规范所有的“规则”条目必须被遵守** 11 | 2. 代码格式 12 | ------------------------ 13 | * **使用统一的 Eclipse 的代码格式** 14 | [anjuke-eclipse-android-code-format-1.0.xml](http://git.corp.anjuke.com/android/init/blob/master/format.xml ) 15 | * **设置统一的保存后的动作Eclipse-Preferences-Java-Editor-Save Action,选中Perform the selected actions on save, 16 | Format source code,Format all lines,选中Organize imports** 17 | 18 | 3. 代码命名规范 19 | ------------------------ 20 | * 包 21 | + **包名必须全部小写，2个以内单词** 22 | + 最好为 1 个单数名词 23 | + **所有项目的包都要以“com.anjuke”为父包** 24 | * 类 25 | + **类中每个单词的首字母必须大写** 26 | + 每个类都以功能性名词结尾，如xxxActivity,xxxFragment,xxxView,xxxAdapter 27 | + **每个类的都应该加上类注释，包括所有者、邮箱及日期** 28 | * 接口 29 | + **如果接口表示一个事件，则应该取名为OnXxxListener** 30 | + 如果表示一种能力，应以"able"、"ible"结尾 31 | * 方法 32 | + **大小写字母混合组成，第一个单词的首字母小写，其后单词的首字母大写** 33 | + **继承的方法可以省略注释，但是被继承方法必须有注释。** 34 | * 变量 35 | + **如果是集合或数组，用复数名词，如pets,houses** 36 | + **成员变量能private就不要default，能default就不要protected，最好不要public** 37 | + 不要在activity中使用静态成员变量 38 | + 不推荐使用下划线 39 | + 局域变量名要尽量短，推荐用缩写，比如 StringBuilder sb 40 | + 非公有，非静态成员变量以m开头 41 | + 静态成员变量以s开头 42 | + 其他变量以小写字母开头 43 | * 常量 44 | + 只能包含字母和\_，字母全部大写，单词之间用\_隔开 45 | * 注释 46 | + **注释必须和代码保持同步** 47 | + **注释中的第一个句子要以（英文）句号、问号或者感叹号结束** 48 | + **如果注释中有超过一个段落，用\ 标签分隔** 49 | + **如果注释中有多个章节，用 \ 标签声明每个章节的标题** 50 | + **如果注释需要换行，用 \ 标签** 51 | + **示例代码以 \\ 包裹** 52 | 4. 资源命名规范 53 | ------------------------ 54 | * 尽量以结构开头，业务结尾，中间用下划线区分: 55 | + layout: activity\_house,fragment\_house,view\_house,listitem\_house 56 | + drawable: selector\_house,shap\_house 57 | * 控件id：尽量以对应控件的各单词英文首字母结尾，如TextView就以tv结尾(house\_tv)，ImageView就以iv结尾(house\_iv)，CheckBox就以cb结尾(house\_cb)，Button就以btn结尾(house\_btn)等 58 | * 菜单（menu）的id：建议以action开头,如action\_house 59 | 5. 开发建议 60 | ------------------------ 61 | * 所有的非AtionBar的界面均采用Fragment（片段式）来实现，在Activity中只做Fragment对象的管理以及ActionBar的处理工作 62 | * 多线程编程时，采用Loader来代替AsyncTask和Thread 63 | * 按功能对Activity和Fragment进行分包（可以考虑将相同功能模块的Activity和Fragment放在同一个包下） 64 | * 不要使用静态全局变量，如果确实需要，可以考虑将其作为Application的成员变量（慎用） 65 | * 如果仅希望一段代码在UI线程执行，可以考虑使用activity.runOnUiThread方法 66 | * 不要在Activity或者Fragment中写跟界面无关的代码 67 | * 不要捕获不处理的异常 68 | 6. [新手指南](http://git.corp.anjuke.com/android/AndroidLibrary/tree/master) 69 | ------------------ 70 | --------------------------------------------------------------------------------