From 457e0d8d24f91a93252837bba8729600fba497ff Mon Sep 17 00:00:00 2001
From: Blankj <625783482@qq.com>
Date: Sat, 6 May 2017 23:25:48 +0800
Subject: [PATCH 01/43] fix: dimen
---
README.md | 28 ++++++++++++++--------------
1 file changed, 14 insertions(+), 14 deletions(-)
diff --git a/README.md b/README.md
index 55be91c..e7d4204 100755
--- a/README.md
+++ b/README.md
@@ -668,28 +668,28 @@ public class MyClass {
- 22sp
- 18sp
- 15sp
- 12sp
+ 22sp
+ 18sp
+ 15sp
+ 12sp
- 40dp
- 24dp
- 14dp
- 10dp
- 4dp
+ 40dp
+ 24dp
+ 14dp
+ 10dp
+ 4dp
- 60dp
- 40dp
- 32dp
+ 60dp
+ 40dp
+ 32dp
```
-布局时在写`margins`和`paddings`时，你应该使用`spacing_xxxx`尺寸格式来布局，而不是像对待`string`字符串一样直接写值。 这样写会非常有感觉，会使组织和改变风格或布局是非常容易。
+布局时在写`margins`和`paddings`时，你应该使用`spacing_xx`尺寸格式来布局，而不是像对待`string`字符串一样直接写值，像这样规范的尺寸很容易修改或重构，会使应用所有用到的尺寸一目了然。 这样写会非常有感觉，会使组织和改变风格或布局是非常容易。
##### 4.4.3 strings.xml
@@ -800,7 +800,7 @@ public class WelcomeActivity {
* author : ${USER}
* e-mail : xxx@xx
* time : ${YEAR}/${MONTH}/${DAY}
- * desc :
+ * desc :
* version: 1.0
*
*/
From ae5fbcea1523be9d880347a29e647e833da22fad Mon Sep 17 00:00:00 2001
From: Blankj <625783482@qq.com>
Date: Mon, 19 Jun 2017 18:07:04 +0800
Subject: [PATCH 02/43] feat: add tools
---
README.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index e7d4204..dffe77d 100755
--- a/README.md
+++ b/README.md
@@ -27,7 +27,7 @@
2. 编码格式统一为**UTF-8**；
3. 编辑完`.java`、 `.xml`等文件后一定要**格式化**（基本格式方面使用 AS 默认模板即可）；
4. 删除多余的import，减少警告出现，可利用AS的`Optimize Imports`(Settings → Keymap → Optimize Imports)快捷键；
-5. AS常用开发插件可以参考这里～**[AS常用开发插件][AS常用开发插件]**
+5. Android开发者工具可以参考这里～**[Android开发者工具][Android开发者工具]**
### 3 命名规范
@@ -1033,7 +1033,7 @@ AS已帮你集成了一些注释模板，我们只需要直接使用即可，在
[Package by features, not layers]: https://medium.com/@cesarmcferreira/package-by-features-not-layers-2d076df1964d#.mp782izhh
[iosched]: https://github.com/google/iosched/tree/master/android/src/main/java/com/google/samples/apps/iosched
[安卓开发规范(updating)]: https://github.com/Blankj/AndroidStandardDevelop
-[AS常用开发插件]: http://www.jianshu.com/p/c76b0d8a642d
+[开发者工具]: http://www.jcodecraeer.com/a/anzhuokaifa/androidkaifa/2017/0526/7973.html
[Android Studio下对资源进行分包]: http://www.jianshu.com/p/8e893581b9c7
[Android开发之版本统一规范]: http://www.jianshu.com/p/db6ef4cfa5d1
[Android 流行框架查速表]: http://www.ctolib.com/cheatsheets-Android-ch.html
From e894bab96bb1205399ab9d77fcbb27255f7bae0c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E5=B8=83=E5=85=B0=E6=9F=AF=E5=9F=BA?=
Date: Wed, 5 Jul 2017 19:26:04 +0800
Subject: [PATCH 03/43] feat: fix tools link
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index dffe77d..373b053 100755
--- a/README.md
+++ b/README.md
@@ -1033,7 +1033,7 @@ AS已帮你集成了一些注释模板，我们只需要直接使用即可，在
[Package by features, not layers]: https://medium.com/@cesarmcferreira/package-by-features-not-layers-2d076df1964d#.mp782izhh
[iosched]: https://github.com/google/iosched/tree/master/android/src/main/java/com/google/samples/apps/iosched
[安卓开发规范(updating)]: https://github.com/Blankj/AndroidStandardDevelop
-[开发者工具]: http://www.jcodecraeer.com/a/anzhuokaifa/androidkaifa/2017/0526/7973.html
+[Android开发者工具]: http://www.jcodecraeer.com/a/anzhuokaifa/androidkaifa/2017/0526/7973.html
[Android Studio下对资源进行分包]: http://www.jianshu.com/p/8e893581b9c7
[Android开发之版本统一规范]: http://www.jianshu.com/p/db6ef4cfa5d1
[Android 流行框架查速表]: http://www.ctolib.com/cheatsheets-Android-ch.html
From bec194e467f1b2dcfb2996f08f89af7ae82b94ed Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E5=B8=83=E5=85=B0=E6=9F=AF=E5=9F=BA?=
Date: Wed, 5 Jul 2017 19:32:40 +0800
Subject: [PATCH 04/43] fix: fix link blod
---
README.md | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index 373b053..76b7c16 100755
--- a/README.md
+++ b/README.md
@@ -16,7 +16,7 @@
### 1 前言
-为了利于项目维护以及规范开发，促进成员之间Code Review的效率，故提出以下开发规范，如有更好建议，欢迎到GitHub提issue，原文地址： **[安卓开发规范(updating)][安卓开发规范(updating)]**
+为了利于项目维护以及规范开发，促进成员之间Code Review的效率，故提出以下开发规范，如有更好建议，欢迎到GitHub提issue，原文地址：**[安卓开发规范(updating)][安卓开发规范(updating)]**
### 2 AS规范
@@ -27,7 +27,7 @@
2. 编码格式统一为**UTF-8**；
3. 编辑完`.java`、 `.xml`等文件后一定要**格式化**（基本格式方面使用 AS 默认模板即可）；
4. 删除多余的import，减少警告出现，可利用AS的`Optimize Imports`(Settings → Keymap → Optimize Imports)快捷键；
-5. Android开发者工具可以参考这里～**[Android开发者工具][Android开发者工具]**
+5. Android开发者工具可以参考这里～ **[Android开发者工具][Android开发者工具]**
### 3 命名规范
@@ -38,7 +38,7 @@
#### 3.1 包名
-包名全部小写，连续的单词只是简单地连接起来，不使用下划线，采用反域名命名规则，全部使用小写字母。一级包名是顶级域名，通常为`com`,`edu`,`gov`,`net`,`org`等，二级包名为公司名，三级包名根据应用进行命名，后面就是对包名的划分了，关于包名的划分，推荐使用按功能分，一开始我们也是按照层去分包的，很坑爹。按照功能分可能你不是很好区分在哪个功能中，不过也比你按照层区分要好找很多。具体可以参考这篇博文～**[Package by features, not layers][Package by features, not layers]**，当然，我们大谷歌也有相应的sample～**[iosched][iosched]**，其结构如下所示，很值得学习。
+包名全部小写，连续的单词只是简单地连接起来，不使用下划线，采用反域名命名规则，全部使用小写字母。一级包名是顶级域名，通常为`com`,`edu`,`gov`,`net`,`org`等，二级包名为公司名，三级包名根据应用进行命名，后面就是对包名的划分了，关于包名的划分，推荐使用按功能分，一开始我们也是按照层去分包的，很坑爹。按照功能分可能你不是很好区分在哪个功能中，不过也比你按照层区分要好找很多。具体可以参考这篇博文～ **[Package by features, not layers][Package by features, not layers]**，当然，我们大谷歌也有相应的sample～ **[iosched][iosched]**，其结构如下所示，很值得学习。
```
java
From cbb3b7f70a6b8203d93baa8b1ee127e3f2776c33 Mon Sep 17 00:00:00 2001
From: Blankj <625783482@qq.com>
Date: Wed, 5 Jul 2017 19:35:49 +0800
Subject: [PATCH 05/43] fix: fix link blod
---
README.md | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index 76b7c16..01fe7f7 100755
--- a/README.md
+++ b/README.md
@@ -487,7 +487,7 @@ public class MyClass {
2. 以类命名方式(参考[3.2 类名](#32-类名))，后面加个大写的`T`(如：`RequestT`, `FooBarT`)。
-更多还可参考～**[阿里巴巴Java开发手册][阿里巴巴Java开发手册]**
+更多还可参考～ **[阿里巴巴Java开发手册][阿里巴巴Java开发手册]**
### 4 资源文件规范
@@ -740,19 +740,19 @@ public class MyClass {
使用`AndroidStudio`的插件`ButterKnife Zelezny`，生成注解非常方便，原生的话可以使用`Android Code Generator`插件。
-如果想对资源文件进行分包可以参考我这篇文章～**[Android Studio下对资源进行分包][Android Studio下对资源进行分包]**
+如果想对资源文件进行分包可以参考我这篇文章～ **[Android Studio下对资源进行分包][Android Studio下对资源进行分包]**
### 5 版本统一规范
Android开发存在着众多版本的不同，比如`compileSdkVersion`、`minSdkVersion`、`targetSdkVersion`以及项目中依赖第三方库的版本，不同的module及不同的开发人员都有不同的版本，所以需要一个统一版本规范的文件。
-具体可以参考我写的这篇博文～**[Android开发之版本统一规范][Android开发之版本统一规范]**
+具体可以参考我写的这篇博文～ **[Android开发之版本统一规范][Android开发之版本统一规范]**
### 6 第三方库规范
-别再闭门造车了，用用最新最火的技术吧，安利一波～**[Android 流行框架查速表][Android 流行框架查速表]**，顺便带上自己的干货～**[Android开发人员不得不收集的代码][Android开发人员不得不收集的代码]**
+别再闭门造车了，用用最新最火的技术吧，安利一波～ **[Android 流行框架查速表][Android 流行框架查速表]**，顺便带上自己的干货～ **[Android开发人员不得不收集的代码][Android开发人员不得不收集的代码]**
希望Team能用时下较新的技术，对开源库的选取，一般都需要选择比较稳定的版本，作者在维护的项目，要考虑作者对issue的解决，以及开发者的知名度等各方面。选取之后，一定的封装是必要的。
From 46f2f894e9268a2872a93f7994095a518b7d9dcf Mon Sep 17 00:00:00 2001
From: Blankj <625783482@qq.com>
Date: Mon, 21 Aug 2017 16:28:35 +0800
Subject: [PATCH 06/43] feat: add launch mode
---
README.md | 82 +++++++++++++++++++++++++++++++++++++++++--------------
1 file changed, 61 insertions(+), 21 deletions(-)
diff --git a/README.md b/README.md
index 01fe7f7..32ace63 100755
--- a/README.md
+++ b/README.md
@@ -869,19 +869,54 @@ AS已帮你集成了一些注释模板，我们只需要直接使用即可，在
### 10 其他的一些规范
1. 合理布局，有效运用``、``、``标签；
+
2. `Activity`和`Fragment`里面有许多重复的操作以及操作步骤，所以我们都需要提供一个`BaseActivity`和`BaseFragment`，让所有的`Activity`和`Fragment`都继承这个基类。
-3. 方法基本上都按照调用的先后顺序在各自区块中排列；
-4. 相关功能作为小区块放在一起（或者封装掉）；
-5. 当一个类有多个构造函数，或是多个同名方法，这些函数/方法应该按顺序出现在一起，中间不要放进其它函数/方法；
-6. 数据提供统一的入口。无论是在 MVP、MVC 还是 MVVM 中，提供一个统一的数据入口，都可以让代码变得更加易于维护。比如可使用一个`DataManager`，把 `http`、`preference`、`eventpost`、`database` 都放在`DataManger`里面进行操作，我们只需要与`DataManger`打交道；
-7. 多用组合, 少用继承；
-8. 提取方法, 去除重复代码。对于必要的工具类抽取也很重要，这在以后的项目中是可以重用的。
-9. 可引入 Dagger2 减少模块之间的耦合性。Dagger2 是一个依赖注入框架，使用代码自动生成创建依赖关系需要的代码。减少很多模板化的代码，更易于测试，降低耦合，创建可复用可互换的模块；
-10. 项目引入`RxJava` + `RxAndroid`这些响应式编程，可以极大的减少逻辑代码；
-11. 通过引入事件总线，如：`EventBus`、`AndroidEventBus`、`RxBus`，它允许我们在`DataLayer`中发送事件，以便`ViewLayer`中的多个组件都能够订阅到这些事件，减少回调；
-12. 尽可能使用局部变量；
-13. 及时关闭流；
-14. 尽量减少对变量的重复计算；
+
+3. 启动`Activity`的话建议使用AS自带的模板，输入`starter`即可，如下所示：
+
+ ``` java
+ public static void start(Context context, String data) {
+ Intent starter = new Intent(context, MainActivity.class);
+ starter.putExtra("data", data);
+ context.startActivity(starter);
+ }
+ ```
+
+ 同理，启动`Fragment`输入`newInstance`即可，如下所示：
+
+ ``` java
+ public static MainFragment newInstance(String data) {
+ Bundle args = new Bundle();
+ args.putString("data", data);
+ MainFragment fragment = new MainFragment();
+ fragment.setArguments(args);
+ return fragment;
+ }
+ ```
+
+4. 方法基本上都按照调用的先后顺序在各自区块中排列；
+
+5. 相关功能作为小区块放在一起（或者封装掉）；
+
+6. 当一个类有多个构造函数，或是多个同名方法，这些函数/方法应该按顺序出现在一起，中间不要放进其它函数/方法；
+
+7. 数据提供统一的入口。无论是在 MVP、MVC 还是 MVVM 中，提供一个统一的数据入口，都可以让代码变得更加易于维护。比如可使用一个`DataManager`，把 `http`、`preference`、`eventpost`、`database` 都放在`DataManger`里面进行操作，我们只需要与`DataManger`打交道；
+
+8. 多用组合, 少用继承；
+
+9. 提取方法, 去除重复代码。对于必要的工具类抽取也很重要，这在以后的项目中是可以重用的。
+
+10. 可引入 Dagger2 减少模块之间的耦合性。Dagger2 是一个依赖注入框架，使用代码自动生成创建依赖关系需要的代码。减少很多模板化的代码，更易于测试，降低耦合，创建可复用可互换的模块；
+
+11. 项目引入`RxJava` + `RxAndroid`这些响应式编程，可以极大的减少逻辑代码；
+
+12. 通过引入事件总线，如：`EventBus`、`AndroidEventBus`、`RxBus`，它允许我们在`DataLayer`中发送事件，以便`ViewLayer`中的多个组件都能够订阅到这些事件，减少回调；
+
+13. 尽可能使用局部变量；
+
+14. 及时关闭流；
+
+15. 尽量减少对变量的重复计算；
如下面的操作：
@@ -894,12 +929,12 @@ AS已帮你集成了一些注释模板，我们只需要直接使用即可，在
建议替换为：
``` java
- for (int i = 0, int length = list.size(); i < length; i++) {
+ for (int i = 0, len = list.size(); i < len; i++) {
...
}
```
-15. 尽量采用懒加载的策略，即在需要的时候才创建；
+16. 尽量采用懒加载的策略，即在需要的时候才创建；
例如：
@@ -919,10 +954,13 @@ AS已帮你集成了一些注释模板，我们只需要直接使用即可，在
}
```
-16. 不要在循环中使用try…catch…，应该把其放在最外层；
-17. 使用带缓冲的输入输出流进行IO操作；
-18. 尽量使用HashMap、ArrayList、StringBuilder，除非线程安全需要，否则不推荐使用Hashtable、Vector、StringBuffer，后三者由于使用同步机制而导致了性能开销；
-19. 尽量在合适的场合使用单例；
+17. 不要在循环中使用try…catch…，应该把其放在最外层；
+
+18. 使用带缓冲的输入输出流进行IO操作；
+
+19. 尽量使用HashMap、ArrayList、StringBuilder，除非线程安全需要，否则不推荐使用Hashtable、Vector、StringBuffer，后三者由于使用同步机制而导致了性能开销；
+
+20. 尽量在合适的场合使用单例；
使用单例可以减轻加载的负担、缩短加载的时间、提高加载的效率，但并不是所有地方都适用于单例，简单来说，单例主要适用于以下三个方面：
@@ -932,9 +970,11 @@ AS已帮你集成了一些注释模板，我们只需要直接使用即可，在
（3）控制数据的共享，在不建立直接关联的条件下，让多个不相关的进程或线程之间实现通信
-20. 把一个基本数据类型转为字符串，`基本数据类型.toString()`是最快的方式、`String.valueOf(数据)`次之、`数据 + ""`最慢；
-21. 使用AS自带的Lint来优化代码结构（什么，你不会？右键module、目录或者文件，选择Analyze → Inspect Code）；
-22. 最后不要忘了内存泄漏的检测；
+21. 把一个基本数据类型转为字符串，`基本数据类型.toString()`是最快的方式、`String.valueOf(数据)`次之、`数据 + ""`最慢；
+
+22. 使用AS自带的Lint来优化代码结构（什么，你不会？右键module、目录或者文件，选择Analyze → Inspect Code）；
+
+23. 最后不要忘了内存泄漏的检测；
---
From 68adf8107dadf5446e033d1281b302ee9674de34 Mon Sep 17 00:00:00 2001
From: Blankj <625783482@qq.com>
Date: Mon, 27 Nov 2017 11:11:25 +0800
Subject: [PATCH 07/43] fix: change the format of point
---
README.md | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/README.md b/README.md
index 32ace63..f31430a 100755
--- a/README.md
+++ b/README.md
@@ -27,7 +27,7 @@
2. 编码格式统一为**UTF-8**；
3. 编辑完`.java`、 `.xml`等文件后一定要**格式化**（基本格式方面使用 AS 默认模板即可）；
4. 删除多余的import，减少警告出现，可利用AS的`Optimize Imports`(Settings → Keymap → Optimize Imports)快捷键；
-5. Android开发者工具可以参考这里～ **[Android开发者工具][Android开发者工具]**
+5. Android开发者工具可以参考这里：**[Android开发者工具][Android开发者工具]**
### 3 命名规范
@@ -38,7 +38,7 @@
#### 3.1 包名
-包名全部小写，连续的单词只是简单地连接起来，不使用下划线，采用反域名命名规则，全部使用小写字母。一级包名是顶级域名，通常为`com`,`edu`,`gov`,`net`,`org`等，二级包名为公司名，三级包名根据应用进行命名，后面就是对包名的划分了，关于包名的划分，推荐使用按功能分，一开始我们也是按照层去分包的，很坑爹。按照功能分可能你不是很好区分在哪个功能中，不过也比你按照层区分要好找很多。具体可以参考这篇博文～ **[Package by features, not layers][Package by features, not layers]**，当然，我们大谷歌也有相应的sample～ **[iosched][iosched]**，其结构如下所示，很值得学习。
+包名全部小写，连续的单词只是简单地连接起来，不使用下划线，采用反域名命名规则，全部使用小写字母。一级包名是顶级域名，通常为`com`、`edu`、`gov`、`net`、`org`等，二级包名为公司名，三级包名根据应用进行命名，后面就是对包名的划分了，关于包名的划分，推荐使用按功能分，一开始我们也是按照层去分包的，很坑爹。按照功能分可能你不是很好区分在哪个功能中，不过也比你按照层区分要好找很多。具体可以参考这篇博文：**[Package by features, not layers][Package by features, not layers]**，当然，我们大谷歌也有相应的sample：**[iosched][iosched]**，其结构如下所示，很值得学习。
```
java
@@ -487,7 +487,7 @@ public class MyClass {
2. 以类命名方式(参考[3.2 类名](#32-类名))，后面加个大写的`T`(如：`RequestT`, `FooBarT`)。
-更多还可参考～ **[阿里巴巴Java开发手册][阿里巴巴Java开发手册]**
+更多还可参考：**[阿里巴巴Java开发手册][阿里巴巴Java开发手册]**
### 4 资源文件规范
@@ -740,19 +740,19 @@ public class MyClass {
使用`AndroidStudio`的插件`ButterKnife Zelezny`，生成注解非常方便，原生的话可以使用`Android Code Generator`插件。
-如果想对资源文件进行分包可以参考我这篇文章～ **[Android Studio下对资源进行分包][Android Studio下对资源进行分包]**
+如果想对资源文件进行分包可以参考我这篇文章：**[Android Studio下对资源进行分包][Android Studio下对资源进行分包]**
### 5 版本统一规范
Android开发存在着众多版本的不同，比如`compileSdkVersion`、`minSdkVersion`、`targetSdkVersion`以及项目中依赖第三方库的版本，不同的module及不同的开发人员都有不同的版本，所以需要一个统一版本规范的文件。
-具体可以参考我写的这篇博文～ **[Android开发之版本统一规范][Android开发之版本统一规范]**
+具体可以参考我写的这篇博文：**[Android开发之版本统一规范][Android开发之版本统一规范]**
### 6 第三方库规范
-别再闭门造车了，用用最新最火的技术吧，安利一波～ **[Android 流行框架查速表][Android 流行框架查速表]**，顺便带上自己的干货～ **[Android开发人员不得不收集的代码][Android开发人员不得不收集的代码]**
+别再闭门造车了，用用最新最火的技术吧，安利一波：**[Android 流行框架查速表][Android 流行框架查速表]**，顺便带上自己的干货：**[Android开发人员不得不收集的代码][Android开发人员不得不收集的代码]**
希望Team能用时下较新的技术，对开源库的选取，一般都需要选择比较稳定的版本，作者在维护的项目，要考虑作者对issue的解决，以及开发者的知名度等各方面。选取之后，一定的封装是必要的。
From c8723876cd8293e476669a0998030805e1d6d8ea Mon Sep 17 00:00:00 2001
From: Blankj <625783482@qq.com>
Date: Mon, 27 Nov 2017 13:47:32 +0800
Subject: [PATCH 08/43] feat: add space
---
README.md | 452 +++++++++++++++++++++++++++---------------------------
1 file changed, 226 insertions(+), 226 deletions(-)
diff --git a/README.md b/README.md
index f31430a..fddab38 100755
--- a/README.md
+++ b/README.md
@@ -1,44 +1,44 @@
-# 安卓开发规范(updating)
+# 安卓开发规范（更新中）
## 摘要
-* [1 前言](#1-前言)
-* [2 AS规范](#2-as规范)
-* [3 命名规范](#3-命名规范)
-* [4 资源文件规范](#4-资源文件规范)
-* [5 版本统一规范](#5-版本统一规范)
-* [6 第三方库规范](#6-第三方库规范)
-* [7 注释规范](#7-注释规范)
-* [8 测试规范](#8-测试规范)
-* [9 RN规范](#9-RN规范)
-* [10 其他的一些规范](#10-其他的一些规范)
+* [1 前言 ](#1- 前言 )
+* [2 AS 规范 ](#2-as 规范 )
+* [3 命名规范 ](#3- 命名规范 )
+* [4 资源文件规范 ](#4- 资源文件规范 )
+* [5 版本统一规范 ](#5- 版本统一规范 )
+* [6 第三方库规范 ](#6- 第三方库规范 )
+* [7 注释规范 ](#7- 注释规范 )
+* [8 测试规范 ](#8- 测试规范 )
+* [9 RN 规范 ](#9-RN 规范 )
+* [10 其他的一些规范 ](#10- 其他的一些规范 )
### 1 前言
-为了利于项目维护以及规范开发，促进成员之间Code Review的效率，故提出以下开发规范，如有更好建议，欢迎到GitHub提issue，原文地址：**[安卓开发规范(updating)][安卓开发规范(updating)]**
+为了利于项目维护以及规范开发，促进成员之间 Code Review 的效率，故提出以下开发规范，如有更好建议，欢迎到 GitHub 提 issue，原文地址：**[ 安卓开发规范 (updating)][ 安卓开发规范 (updating)]**
-### 2 AS规范
+### 2 AS 规范
工欲善其事，必先利其器。
-1. 尽量使用最新版的IDE进行开发；
-2. 编码格式统一为**UTF-8**；
-3. 编辑完`.java`、 `.xml`等文件后一定要**格式化**（基本格式方面使用 AS 默认模板即可）；
-4. 删除多余的import，减少警告出现，可利用AS的`Optimize Imports`(Settings → Keymap → Optimize Imports)快捷键；
-5. Android开发者工具可以参考这里：**[Android开发者工具][Android开发者工具]**
+1. 尽量使用最新版的 IDE 进行开发；
+2. 编码格式统一为 **UTF-8**;
+3. 编辑完 `.java`、 `.xml` 等文件后一定要 ** 格式化 **（基本格式方面使用 AS 默认模板即可）；
+4. 删除多余的 import，减少警告出现，可利用 AS 的 `Optimize Imports`(Settings → Keymap → Optimize Imports) 快捷键；
+5. Android 开发者工具可以参考这里：**[Android 开发者工具 ][Android 开发者工具 ]**
### 3 命名规范
-代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。正确的英文拼写和语法可以让阅读者易于理解,避免歧义。
+代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。正确的英文拼写和语法可以让阅读者易于理解，避免歧义。
-> 注意：即使纯拼音命名方式也要避免采用。但`alibaba`、`taobao`、`youku`、`hangzhou`等国际通用的名称,可视同英文。
+> 注意：即使纯拼音命名方式也要避免采用。但 `alibaba`、`taobao`、`youku`、`hangzhou` 等国际通用的名称，可视同英文。
#### 3.1 包名
-包名全部小写，连续的单词只是简单地连接起来，不使用下划线，采用反域名命名规则，全部使用小写字母。一级包名是顶级域名，通常为`com`、`edu`、`gov`、`net`、`org`等，二级包名为公司名，三级包名根据应用进行命名，后面就是对包名的划分了，关于包名的划分，推荐使用按功能分，一开始我们也是按照层去分包的，很坑爹。按照功能分可能你不是很好区分在哪个功能中，不过也比你按照层区分要好找很多。具体可以参考这篇博文：**[Package by features, not layers][Package by features, not layers]**，当然，我们大谷歌也有相应的sample：**[iosched][iosched]**，其结构如下所示，很值得学习。
+包名全部小写，连续的单词只是简单地连接起来，不使用下划线，采用反域名命名规则，全部使用小写字母。一级包名是顶级域名，通常为 `com`、`edu`、`gov`、`net`、`org` 等，二级包名为公司名，三级包名根据应用进行命名，后面就是对包名的划分了，关于包名的划分，推荐使用按功能分，一开始我们也是按照层去分包的，很坑爹。按照功能分可能你不是很好区分在哪个功能中，不过也比你按照层区分要好找很多。具体可以参考这篇博文：**[Package by features, not layers][Package by features, not layers]**，当然，我们大谷歌也有相应的例子：**[iosched][iosched]**，其结构如下所示，很值得学习。
```
java
@@ -47,7 +47,7 @@ java
└─samples
└─apps
└─iosched
- │ AppApplication.java 定义Application类
+ │ AppApplication.java 定义 Application 类
│ Config.java 定义配置数据（常量）
│
├─about
@@ -90,7 +90,7 @@ java
│ FragmentListener.java
│ LoaderIdlingResource.java
│ Model.java
- │ ...定义interface并实现
+ │ ... 定义 interface 并实现
│
├─gcm
│ │ GCMCommand.java
@@ -108,7 +108,7 @@ java
│ │ BlocksHandler.java
│ │ HandlerException.java
│ │ HashtagsHandler.java
- │ │ ...处理model
+ │ │ ... 处理 model
│ │
│ ├─map
│ │ └─model
@@ -138,7 +138,7 @@ java
│ ScheduleHelper.java
│ ScheduleItem.java
│ ScheduleItemHelper.java
- │ ...定义model以及实现model相关操作
+ │ ... 定义 model 以及实现 model 相关操作
│
├─myschedule
│ MyScheduleActivity.java
@@ -150,8 +150,8 @@ java
│ ScheduleContract.java
│ ScheduleContractHelper.java
│ ScheduleDatabase.java
- │ ...实现ContentProvider
- │ （也在此处定义provider依赖的其它类，比如db操作）
+ │ ... 实现 ContentProvider
+ │ （也在此处定义 provider 依赖的其它类，比如 db 操作）
│
├─receiver
│ SessionAlarmReceiver.java
@@ -201,19 +201,19 @@ java
│ │ BaseActivity.java
│ │ CheckableLinearLayout.java
│ │ SearchActivity.java
- │ │ ...BaseActivity以及自定义UI组件
+ │ │ ...BaseActivity 以及自定义 UI 组件
│ │
│ └─widget
│ AspectRatioView.java
│ BakedBezierInterpolator.java
│ BezelImageView.java
- │ ...自定义小UI控件
+ │ ... 自定义小 UI 控件
│
├─util
│ AboutUtils.java
│ AccountUtils.java
│ AnalyticsHelper.java
- │ ...工具类，提供静态方法
+ │ ... 工具类，提供静态方法
│
├─videolibrary
│ VideoLibraryActivity.java
@@ -228,161 +228,161 @@ java
...
```
-参考Google I/O 2015的代码结构，按功能分包具体可以这样做：
+参考 Google I/O 2015 的代码结构，按功能分包具体可以这样做：
```
src
└─com
└─domain
└─app
- │ AppApplication.java 定义Application类
+ │ AppApplication.java 定义 Application 类
│ Config.java 定义配置数据（常量）
│
├─framework
- │ 定义interface以及相关基类
+ │ 定义 interface 以及相关基类
│
├─io
- │ 数据定义（model）、数据操作（比如json解析，但不包括db操作）
+ │ 数据定义（model）、数据操作（比如 json 解析，但不包括 db 操作）
│
├─model
- │ 定义model（数据结构以及getter/setter、compareTo、equals等等，不含复杂操作）
- │ 以及modelHelper（提供便于操作model的api）
+ │ 定义 model（数据结构以及 getter/setter、compareTo、equals 等等，不含复杂操作）
+ │ 以及 modelHelper（提供便于操作 model 的 api）
│
├─provider
- │ 实现ContentProvider，及其依赖的db操作
+ │ 实现 ContentProvider，及其依赖的 db 操作
│
├─receiver
- │ 实现Receiver
+ │ 实现 Receiver
│
├─service
- │ 实现Service（比如IntentService），用于在独立线程中异步do stuff
+ │ 实现 Service（比如 IntentService），用于在独立线程中异步 do stuff
│
├─ui
- │ 实现BaseActivity，以及自定义view和widget，相关的Adapter也放这里
+ │ 实现 BaseActivity，以及自定义 view 和 widget，相关的 Adapter 也放这里
│
├─util
│ 实现工具类，提供静态方法
│
├─feature1
- │ Item.java 定义model
- │ ItemHelper.java 实现modelHelper
- │ feature1Activity.java 定义UI
- │ feature1DAO.java 私有db操作
+ │ Item.java 定义 model
+ │ ItemHelper.java 实现 modelHelper
+ │ feature1Activity.java 定义 UI
+ │ feature1DAO.java 私有 db 操作
│ feature1Utils.java 私有工具函数
- │ ...其它私有class
+ │ ... 其它私有 class
│
- ├─...其它feature
+ ├─... 其它 feature
```
-PBF(按功能分包Package By Feature)与PBL(按层分包Package By Layer)相比较有如下优势：
+PBF( 按功能分包 Package By Feature) 与 PBL( 按层分包 Package By Layer) 相比较有如下优势：
-* package内高内聚，package间低耦合
+* package 内高内聚，package 间低耦合
-哪块要添新功能，只改某一个package下的东西
+哪块要添新功能，只改某一个 package 下的东西
-按class职能分层（PBL）降低了代码耦合，但带来了package耦合，要添新功能，需要改model、dbHelper、view、service等等，需要改动好几个package下的代码，改动的地方越多，越容易产生新问题，不是吗？
+按 class 职能分层（PBL）降低了代码耦合，但带来了 package 耦合，要添新功能，需要改 model、dbHelper、view、service 等等，需要改动好几个 package 下的代码，改动的地方越多，越容易产生新问题，不是吗？
-按功能分包（PBF），featureA相关的所有东西都在featureA包，feature内高内聚高度模块化，不同feature之间低耦合，相关的东西都放在一起，还好找
+按功能分包（PBF），featureA 相关的所有东西都在 featureA 包，feature 内高内聚高度模块化，不同 feature 之间低耦合，相关的东西都放在一起，还好找
-* package有私有作用域（package-private scope）
+* package 有私有作用域（package-private scope）
你负责开发这块功能，这个目录下所有东西都是你的
-PBL的方式是把所有工具方法都放在util包下，小张开发新功能时候发现需要一个xxUtil，但它又不是通用的，那应该放在哪里？没办法，按照分层原则，我们还得放在util包下，好像不太合适，但放在其它包更不合适，功能越来越多，util类也越定义越多。后来小李负责开发一块功能时发现需要一个xxUtil，同样不通用，去util包一看，怎么已经有了，而且还没法复用，只好放弃xx这个名字，改为xxxUtil……因为PBL的package没有私有作用域，每一个包都是public（跨包方法调用是很平常的事情，每一个包对其它包来说都是可访问的）
+PBL 的方式是把所有工具方法都放在 util 包下，小张开发新功能时候发现需要一个 xxUtil，但它又不是通用的，那应该放在哪里？没办法，按照分层原则，我们还得放在 util 包下，好像不太合适，但放在其它包更不合适，功能越来越多，util 类也越定义越多。后来小李负责开发一块功能时发现需要一个 xxUtil，同样不通用，去 util 包一看，怎么已经有了，而且还没法复用，只好放弃 xx 这个名字，改为 xxxUtil……因为 PBL 的 package 没有私有作用域，每一个包都是 public（跨包方法调用是很平常的事情，每一个包对其它包来说都是可访问的）
-如果是PBF，小张的xxUtil自然放在feautreA下，小李的xxUtil在featureB下，如果觉得util好像是通用的，就去util包看看要不要把工具方法添进xxUtil，class命名冲突没有了
+如果是 PBF，小张的 xxUtil 自然放在 feautreA 下，小李的 xxUtil 在 featureB 下，如果觉得 util 好像是通用的，就去 util 包看看要不要把工具方法添进 xxUtil,class 命名冲突没有了
-PBF的package有私有作用域，featureA不应该访问featureB下的任何东西（如果非访问不可，那就说明接口定义有问题）
+PBF 的 package 有私有作用域，featureA 不应该访问 featureB 下的任何东西（如果非访问不可，那就说明接口定义有问题）
* 很容易删除功能
统计发现新功能没人用，这个版本那块功能得去掉
-如果是PBL，得从功能入口到整个业务流程把受到牵连的所有能删的代码和class都揪出来删掉，一不小心就完蛋
+如果是 PBL，得从功能入口到整个业务流程把受到牵连的所有能删的代码和 class 都揪出来删掉，一不小心就完蛋
-如果是PBF，好说，先删掉对应包，再删掉功能入口（删掉包后入口肯定报错了），完事
+如果是 PBF，好说，先删掉对应包，再删掉功能入口（删掉包后入口肯定报错了），完事
* 高度抽象
-解决问题的一般方法是从抽象到具体，PBF包名是对功能模块的抽象，包内的class是实现细节，符合从抽象到具体，而PBL弄反了
+解决问题的一般方法是从抽象到具体，PBF 包名是对功能模块的抽象，包内的 class 是实现细节，符合从抽象到具体，而 PBL 弄反了
-PBF从确定AppName开始，根据功能模块划分package，再考虑每块的具体实现细节，而PBL从一开始就要考虑要不要dao层，要不要com层等等
+PBF 从确定 AppName 开始，根据功能模块划分 package，再考虑每块的具体实现细节，而 PBL 从一开始就要考虑要不要 dao 层，要不要 com 层等等
-* 只通过class来分离逻辑代码
+* 只通过 class 来分离逻辑代码
-PBL既分离class又分离package，而PBF只通过class来分离逻辑代码
+PBL 既分离 class 又分离 package，而 PBF 只通过 class 来分离逻辑代码
-没有必要通过package分离，因为PBL中也可能出现尴尬的情况：
+没有必要通过 package 分离，因为 PBL 中也可能出现尴尬的情况：
```
├─service
│ MainServ.java
```
-按照PBL，service包下的所有东西都是Controller，应该不需要Serv后缀，但实际上通常为了码起来方便，直接import service包，Serv后缀是为了避免引入的class和当前包下的class命名冲突，当然，不用后缀也可以，得写清楚包路径，比如new net.ayqy.service.Main()，麻烦
+按照 PBL,service 包下的所有东西都是 Controller，应该不需要 Serv 后缀，但实际上通常为了码起来方便，直接 import service 包，Serv 后缀是为了避免引入的 class 和当前包下的 class 命名冲突，当然，不用后缀也可以，得写清楚包路径，比如 new net.ayqy.service.Main()，麻烦
-而PBF就很方便，无需import，直接new MainServ()即可
+而 PBF 就很方便，无需 import，直接 new MainServ() 即可
-* package的大小有意义了
+* package 的大小有意义了
-PBL中包的大小无限增长是合理的，因为功能越添越多
+PBL 中包的大小无限增长是合理的，因为功能越添越多
-而PBF中包太大（包里class太多）表示这块需要重构（划分子包）
+而 PBF 中包太大（包里 class 太多）表示这块需要重构（划分子包）
#### 3.2 类名
-类名都以`UpperCamelCase`风格编写。
+类名都以 `UpperCamelCase` 风格编写。
类名通常是名词或名词短语，接口名称有时可能是形容词或形容词短语。现在还没有特定的规则或行之有效的约定来命名注解类型。
-名词，采用大驼峰命名法，尽量避免缩写，除非该缩写是众所周知的， 比如`HTML`, `URL`，如果类名称中包含单词缩写，则单词缩写的每个字母均应大写。
+名词，采用大驼峰命名法，尽量避免缩写，除非该缩写是众所周知的， 比如 `HTML`, `URL`，如果类名称中包含单词缩写，则单词缩写的每个字母均应大写。
| 类 | 描述 | 例如 |
| :----------------- | :--------------------------------------- | :--------------------------------------- |
-| Activity 类 | Activity为后缀标识 | 欢迎页面类WelcomeActivity |
-| Adapter类 | Adapter 为后缀标识 | 新闻详情适配器 NewDetailAdapter |
-| 解析类 | Parser为后缀标识 | 首页解析类HomePosterParser |
-| 工具方法类 | Utils或Manager为后缀标识（与系统或第三方的Utils区分）或功能+Utils | 线程池管理类：ThreadPoolManager日志工具类：LogUtils（Logger也可）打印工具类：PrinterUtils |
-| 数据库类 | 以DBHelper后缀标识 | 新闻数据库：NewDBHelper |
-| Service类 | 以Service为后缀标识 | 时间服务TimeService |
-| BroadcastReceiver类 | 以Receiver为后缀标识 | 推送接收JPushReceiver |
-| ContentProvider类 | 以Provider为后缀标识 | ShareProvider |
-| 自定义的共享基础类 | 以Base开头 | BaseActivity,BaseFragment |
-
-测试类的命名以它要测试的类的名称开始，以Test结束。例如：`HashTest`或`HashIntegrationTest`。
-
-接口（interface）：命名规则与类一样采用大驼峰命名法，多以able或ible结尾，如
+| Activity 类 | Activity 为后缀标识 | 欢迎页面类 WelcomeActivity |
+| Adapter 类 | Adapter 为后缀标识 | 新闻详情适配器 NewDetailAdapter |
+| 解析类 | Parser 为后缀标识 | 首页解析类 HomePosterParser |
+| 工具方法类 | Utils 或 Manager 为后缀标识（与系统或第三方的 Utils 区分）或功能 +Utils | 线程池管理类：ThreadPoolManager 日志工具类：LogUtils（Logger 也可）打印工具类：PrinterUtils |
+| 数据库类 | 以 DBHelper 后缀标识 | 新闻数据库：NewDBHelper |
+| Service 类 | 以 Service 为后缀标识 | 时间服务 TimeService |
+| BroadcastReceiver 类 | 以 Receiver 为后缀标识 | 推送接收 JPushReceiver |
+| ContentProvider 类 | 以 Provider 为后缀标识 | ShareProvider |
+| 自定义的共享基础类 | 以 Base 开头 | BaseActivity,BaseFragment |
+
+测试类的命名以它要测试的类的名称开始，以 Test 结束。例如：`HashTest` 或 `HashIntegrationTest`。
+
+接口（interface）：命名规则与类一样采用大驼峰命名法，多以 able 或 ible 结尾，如
`interface Runnable`、`interface Accessible`。
-> 注意：如果项目采用MVP，所有Model、View、Presenter的接口都以I为前缀，不加后缀，其他的接口采用上述命名规则。
+> 注意：如果项目采用 MVP，所有 Model、View、Presenter 的接口都以 I 为前缀，不加后缀，其他的接口采用上述命名规则。
#### 3.3 方法名
-方法名都以`lowerCamelCase`风格编写。
+方法名都以 `lowerCamelCase` 风格编写。
方法名通常是动词或动词短语。
| 方法 | 说明 |
| :--------------------- | ------------------------------------ |
-| initXX() | 初始化相关方法,使用init为前缀标识，如初始化布局initView() |
-| isXX() checkXX() | 方法返回值为boolean型的请使用is或check为前缀标识 |
-| getXX() | 返回某个值的方法，使用get为前缀标识 |
+| initXX() | 初始化相关方法，使用 init 为前缀标识，如初始化布局 initView() |
+| isXX() checkXX() | 方法返回值为 boolean 型的请使用 is 或 check 为前缀标识 |
+| getXX() | 返回某个值的方法，使用 get 为前缀标识 |
| setXX() | 设置某个属性值 |
| handleXX()/processXX() | 对数据进行处理的方法 |
-| displayXX()/showXX() | 弹出提示框和提示信息，使用display/show为前缀标识 |
+| displayXX()/showXX() | 弹出提示框和提示信息，使用 display/show 为前缀标识 |
| updateXX() | 更新数据 |
| saveXX() | 保存数据 |
| resetXX() | 重置数据 |
| clearXX() | 清除数据 |
-| removeXX() | 移除数据或者视图等，如removeView(); |
-| drawXX() | 绘制数据或效果相关的，使用draw前缀标识 |
+| removeXX() | 移除数据或者视图等，如 removeView(); |
+| drawXX() | 绘制数据或效果相关的，使用 draw 前缀标识 |
#### 3.4 常量名
-常量名命名模式为`CONSTANT_CASE`，全部字母大写，用下划线分隔单词。那，到底什么算是一个常量？
+常量名命名模式为 `CONSTANT_CASE`，全部字母大写，用下划线分隔单词。那，到底什么算是一个常量？
-每个常量都是一个静态`final`字段，但不是所有静态`final`字段都是常量。在决定一个字段是否是一个常量时，考虑它是否真的感觉像是一个常量。例如，如果任何一个该实例的观测状态是可变的，则它几乎肯定不会是一个常量。只是永远不打算改变对象一般是不够的，它要真的一直不变才能将它示为常量。
+每个常量都是一个静态 `final` 字段，但不是所有静态 `final` 字段都是常量。在决定一个字段是否是一个常量时，考虑它是否真的感觉像是一个常量。例如，如果任何一个该实例的观测状态是可变的，则它几乎肯定不会是一个常量。只是永远不打算改变对象一般是不够的，它要真的一直不变才能将它示为常量。
```java
// Constants
@@ -404,17 +404,17 @@ static final String[] nonEmptyArray = {"these", "can", "change"};
#### 3.5 非常量字段名
-非常量字段名以`lowerCamelCase`风格的基础上改造为如下风格：基本结构为`scopeVariableNameType`。
+非常量字段名以 `lowerCamelCase` 风格的基础上改造为如下风格：基本结构为 `scopeVariableNameType`。
-**scope：范围**
+**scope：范围 **
-非公有，非静态字段命名以m开头。
+非公有，非静态字段命名以 m 开头。
-静态字段命名以s开头。
+静态字段命名以 s 开头。
-公有非静态字段命名以p开头。
+公有非静态字段命名以 p 开头。
-公有静态字段（全局变量）命名以g开头。
+公有静态字段（全局变量）命名以 g 开头。
例子：
@@ -429,19 +429,19 @@ public class MyClass {
}
```
-使用1字符前缀来表示作用范围，1个字符的前缀必须小写，前缀后面是由表意性强的一个单词或多个单词组成的名字，而且每个单词的首写字母大写，其它字母小写，这样保证了对变量名能够进行正确的断句。
+使用 1 字符前缀来表示作用范围，1 个字符的前缀必须小写，前缀后面是由表意性强的一个单词或多个单词组成的名字，而且每个单词的首写字母大写，其它字母小写，这样保证了对变量名能够进行正确的断句。
-**Type：类型**
+**Type：类型 **
-考虑到Android中使用很多UI控件，为避免控件和普通成员变量混淆以及更好达意，所有用来表示控件的成员变量统一加上控件缩写作为后缀（文末附有缩写表）。
+考虑到 Android 中使用很多 UI 控件，为避免控件和普通成员变量混淆以及更好达意，所有用来表示控件的成员变量统一加上控件缩写作为后缀（文末附有缩写表）。
对于普通变量一般不添加类型后缀，如果统一添加类型后缀，请参考文末的缩写表。
用统一的量词通过在结尾处放置一个量词，就可创建更加统一的变量，它们更容易理解，也更容易搜索。
-> 注意：如果项目中使用`ButterKnife`，则不添加m前缀，以`lowerCamelCase`风格命名。
+> 注意：如果项目中使用 `ButterKnife`，则不添加 m 前缀，以 `lowerCamelCase` 风格命名。
-例如，请使用`mCustomerStrFirst`和`mCustomerStrLast`，而不要使用`mFirstCustomerStr`和`mLastCustomerStr`。
+例如，请使用 `mCustomerStrFirst` 和 `mCustomerStrLast`，而不要使用 `mFirstCustomerStr` 和 `mLastCustomerStr`。
| 量词列表 | 量词后缀说明 |
| ----- | ----------- |
@@ -456,148 +456,148 @@ public class MyClass {
集合添加如下后缀：List、Map、Set
数组添加如下后缀：Arr
-> 注意：所有的VO（值对象）统一采用标准的lowerCamelCase风格编写，所有的DTO（数据传输对象）就按照接口文档中定义的字段名编写。
+> 注意：所有的 VO（值对象）统一采用标准的 lowerCamelCase 风格编写，所有的 DTO（数据传输对象）就按照接口文档中定义的字段名编写。
#### 3.6 参数名
-参数名以`lowerCamelCase`风格编写。
+参数名以 `lowerCamelCase` 风格编写。
参数应该避免用单个字符命名。
#### 3.7 局部变量名
-局部变量名以`lowerCamelCase`风格编写，比起其它类型的名称，局部变量名可以有更为宽松的缩写。
+局部变量名以 `lowerCamelCase` 风格编写，比起其它类型的名称，局部变量名可以有更为宽松的缩写。
虽然缩写更宽松，但还是要避免用单字符进行命名，除了临时变量和循环变量。
-即使局部变量是final和不可改变的，也不应该把它示为常量，自然也不能用常量的规则去命名它。
+即使局部变量是 final 和不可改变的，也不应该把它示为常量，自然也不能用常量的规则去命名它。
#### 3.8 临时变量
-临时变量通常被取名为`i`、`j`、`k`、`m`和`n`，它们一般用于整型；`c`、`d`、`e`，它们一般用于字符型。 如：`for (int i = 0; i < len ; i++)`。
+临时变量通常被取名为 `i`、`j`、`k`、`m` 和 `n`，它们一般用于整型；`c`、`d`、`e`，它们一般用于字符型。 如：`for (int i = 0; i < len ; i++)`。
#### 3.9 类型变量名
类型变量可用以下两种风格之一进行命名：
-1. 单个的大写字母，后面可以跟一个数字(如：`E`, `T`, `X`, `T2`)。
-2. 以类命名方式(参考[3.2 类名](#32-类名))，后面加个大写的`T`(如：`RequestT`, `FooBarT`)。
+1. 单个的大写字母，后面可以跟一个数字 ( 如：`E`, `T`, `X`, `T2`)。
+2. 以类命名方式 ( 参考 [3.2 类名 ](#32- 类名 ))，后面加个大写的 `T`( 如：`RequestT`, `FooBarT`)。
-更多还可参考：**[阿里巴巴Java开发手册][阿里巴巴Java开发手册]**
+更多还可参考：**[ 阿里巴巴 Java 开发手册 ][ 阿里巴巴 Java 开发手册 ]**
### 4 资源文件规范
-#### 4.1 资源布局文件（XML文件（layout布局文件））
+#### 4.1 资源布局文件（XML 文件（layout 布局文件））
全部小写，采用下划线命名法
-##### 4.1.1 contentView命名
+##### 4.1.1 contentView 命名
必须以全部单词小写，单词间以下划线分割，使用名词或名词词组。
-所有Activity或Fragment的contentView必须与其类名对应，对应规则为：将所有字母都转为小写，将类型和功能调换（也就是后缀变前缀）。
+所有 Activity 或 Fragment 的 contentView 必须与其类名对应，对应规则为：将所有字母都转为小写，将类型和功能调换（也就是后缀变前缀）。
例如：`activity_main.xml`
-##### 4.1.2 Dialog命名
+##### 4.1.2 Dialog 命名
-规则：`dialog_描述.xml`
+规则：`dialog_ 描述.xml`
例如：`dialog_hint.xml`
-##### 4.1.3 PopupWindow命名
+##### 4.1.3 PopupWindow 命名
-规则：`ppw_描述.xml`
+规则：`ppw_ 描述.xml`
例如：`ppw_info.xml`
##### 4.1.4 列表项命名
-规则：`item_描述.xml`
+规则：`item_ 描述.xml`
例如：`item_city.xml`
##### 4.1.5 包含项命名
-规则：`模块_(位置)描述.xml`
+规则：` 模块 _( 位置 ) 描述.xml`
例如：`activity_main_head.xml`、`activity_main_bottom.xml`
-注意：通用的包含项命名采用：`项目名称缩写_描述.xml`
+注意：通用的包含项命名采用：` 项目名称缩写 _ 描述.xml`
例如：`xxxx_title.xml`
-#### 4.2 资源文件（图片drawable文件夹下）
+#### 4.2 资源文件（图片 drawable 文件夹下）
全部小写，采用下划线命名法，加前缀区分
命名模式：可加后缀 `_small` 表示小图， `_big` 表示大图，逻辑名称可由多个单词加下划线组成，采用以下规则：
-* `用途_模块名_逻辑名称`
-* `用途_模块名_颜色`
-* `用途_逻辑名称`
-* `用途_颜色`
+* ` 用途 _ 模块名 _ 逻辑名称 `
+* ` 用途 _ 模块名 _ 颜色 `
+* ` 用途 _ 逻辑名称 `
+* ` 用途 _ 颜色 `
-说明：用途也指控件类型（具体见附录[UI控件缩写表](#ui控件缩写表)）
+说明：用途也指控件类型（具体见附录 [UI 控件缩写表 ](#ui 控件缩写表 )）
例如：
| 名称 | 说明 |
| ----------------------- | ----------------------- |
-| btn_main_home.png | 按键`用途_模块名_逻辑名称` |
-| divider_maket_white.png | 分割线`用途_模块名_颜色` |
-| ic_edit.png | 图标`用途_逻辑名称` |
-| bg_main.png | 背景`用途_逻辑名称` |
-| btn_red.png | 红色按键`用途_颜色` |
-| btn_red_big.png | 红色大按键`用途_颜色` |
-| ic_head_small.png | 小头像`用途_逻辑名称` |
-| bg_input.png | 输入框背景`用途_逻辑名称` |
-| divider_white.png | 白色分割线`用途_颜色` |
-| bg_main_head | 主模块头部背景图片`用途_模块名_逻辑名称` |
-| def_search_cell | 默认搜索界面单元图片`用途_模块名_逻辑名称` |
-| ic_more_help | 更多帮助图标`用途_逻辑名称` |
-| divider_list_line | 列表分割线`用途_逻辑名称` |
-| sel_search_ok | 搜索界面确认选择器`用途_模块名_逻辑名称` |
-| shape_music_ring | 音乐界面环形形状`用途_模块名_逻辑名称` |
+| btn_main_home.png | 按键 ` 用途 _ 模块名 _ 逻辑名称 ` |
+| divider_maket_white.png | 分割线 ` 用途 _ 模块名 _ 颜色 ` |
+| ic_edit.png | 图标 ` 用途 _ 逻辑名称 ` |
+| bg_main.png | 背景 ` 用途 _ 逻辑名称 ` |
+| btn_red.png | 红色按键 ` 用途 _ 颜色 ` |
+| btn_red_big.png | 红色大按键 ` 用途 _ 颜色 ` |
+| ic_head_small.png | 小头像 ` 用途 _ 逻辑名称 ` |
+| bg_input.png | 输入框背景 ` 用途 _ 逻辑名称 ` |
+| divider_white.png | 白色分割线 ` 用途 _ 颜色 ` |
+| bg_main_head | 主模块头部背景图片 ` 用途 _ 模块名 _ 逻辑名称 ` |
+| def_search_cell | 默认搜索界面单元图片 ` 用途 _ 模块名 _ 逻辑名称 ` |
+| ic_more_help | 更多帮助图标 ` 用途 _ 逻辑名称 ` |
+| divider_list_line | 列表分割线 ` 用途 _ 逻辑名称 ` |
+| sel_search_ok | 搜索界面确认选择器 ` 用途 _ 模块名 _ 逻辑名称 ` |
+| shape_music_ring | 音乐界面环形形状 ` 用途 _ 模块名 _ 逻辑名称 ` |
如果有多种形态，如按钮选择器：`sel_btn_xx.xml`
| 名称 | 说明 |
| -------------------- | ---------------------------- |
-| sel_btn_xx | 按钮图片使用`btn_整体效果`（selector） |
-| btn_xx_normal | 按钮图片使用`btn_正常情况效果` |
-| btn_xx_pressed | 按钮图片使用`btn_点击时候效果` |
-| btn_xx_focused | `state_focused`聚焦效果 |
-| btn_xx_disabled | `state_enabled` (false)不可用效果 |
-| btn_xx_checked | `state_checked`选中效果 |
-| btn_xx_selected | `state_selected`选中效果 |
-| btn_xx_hovered | `state_hovered`悬停效果 |
-| btn_xx_checkable | `state_checkable`可选效果 |
-| btn_xx_activated | `state_activated`激活的 |
+| sel_btn_xx | 按钮图片使用 `btn_ 整体效果 `（selector） |
+| btn_xx_normal | 按钮图片使用 `btn_ 正常情况效果 ` |
+| btn_xx_pressed | 按钮图片使用 `btn_ 点击时候效果 ` |
+| btn_xx_focused | `state_focused` 聚焦效果 |
+| btn_xx_disabled | `state_enabled` (false) 不可用效果 |
+| btn_xx_checked | `state_checked` 选中效果 |
+| btn_xx_selected | `state_selected` 选中效果 |
+| btn_xx_hovered | `state_hovered` 悬停效果 |
+| btn_xx_checkable | `state_checkable` 可选效果 |
+| btn_xx_activated | `state_activated` 激活的 |
| btn_xx_windowfocused | `state_window_focused` |
-> 注意：使用AndroidStudio的插件`SelectorChapek`可以快速生成selector，前提是命名要规范。
+> 注意：使用 AndroidStudio 的插件 `SelectorChapek` 可以快速生成 selector，前提是命名要规范。
-#### 4.3 动画文件（anim文件夹下）
+#### 4.3 动画文件（anim 文件夹下）
全部小写，采用下划线命名法，加前缀区分。
-具体动画采用以下规则：`模块名_逻辑名称`。
+具体动画采用以下规则：` 模块名 _ 逻辑名称 `。
例如：`refresh_progress.xml`、`market_cart_add.xml`、`market_cart_remove.xml`。
-普通的tween动画采用如下表格中的命名方式：`动画类型_方向`
+普通的 tween 动画采用如下表格中的命名方式：` 动画类型 _ 方向 `
| 名称 | 说明 |
| ----------------- | ------- |
@@ -612,13 +612,13 @@ public class MyClass {
| shrink_to_middle | 中间缩小 |
-#### 4.4 values中name命名
+#### 4.4 values 中 name 命名
##### 4.4.1 colors.xml
-`colors.xml`的`name`命名使用下划线命名法，在你的`colors.xml`文件中应该只是映射颜色的名称一个ARGB值，而没有其它的。不要使用它为不同的按钮来定义ARGB值。
+`colors.xml` 的 `name` 命名使用下划线命名法，在你的 `colors.xml` 文件中应该只是映射颜色的名称一个 ARGB 值，而没有其它的。不要使用它为不同的按钮来定义 ARGB 值。
-**不要这样做**
+** 不要这样做 **
```xml
@@ -632,9 +632,9 @@ public class MyClass {
#323232
```
-使用这种格式，你会非常容易的开始重复定义ARGB值，这使如果需要改变基本色变的很复杂。同时，这些定义是跟一些环境关联起来的，如`button`或者`comment`, 应该放到一个按钮风格中，而不是在`colors.xml`文件中。
+使用这种格式，你会非常容易的开始重复定义 ARGB 值，这使如果需要改变基本色变的很复杂。同时，这些定义是跟一些环境关联起来的，如 `button` 或者 `comment`, 应该放到一个按钮风格中，而不是在 `colors.xml` 文件中。
-**相反，这样做**
+** 相反，这样做 **
```xml
@@ -655,14 +655,14 @@ public class MyClass {
```
-向应用设计者那里要这个调色板，名称不需要跟`"green"`、`"blue"`等等相同。`"brand_primary"`、`"brand_secondary"`、`"brand_negative"`这样的名字也是完全可以接受的。 像这样规范的颜色很容易修改或重构，会使应用一共使用了多少种不同的颜色变得非常清晰。 通常一个具有审美价值的UI来说，减少使用颜色的种类是非常重要的。
+向应用设计者那里要这个调色板，名称不需要跟 `"green"`、`"blue"` 等等相同。`"brand_primary"`、`"brand_secondary"`、`"brand_negative"` 这样的名字也是完全可以接受的。 像这样规范的颜色很容易修改或重构，会使应用一共使用了多少种不同的颜色变得非常清晰。 通常一个具有审美价值的 UI 来说，减少使用颜色的种类是非常重要的。
-> 注意：如果某些颜色和主题有关，那就单独写一个`colors_theme.xml`。
+> 注意：如果某些颜色和主题有关，那就单独写一个 `colors_theme.xml`。
##### 4.4.2 dimens.xml
-像对待`colors.xml`一样对待`dimens.xml`文件 与定义颜色调色板一样，你同时也应该定义一个空隙间隔和字体大小的“调色板”。 一个好的例子，如下所示：
+像对待 `colors.xml` 一样对待 `dimens.xml` 文件 与定义颜色调色板一样，你同时也应该定义一个空隙间隔和字体大小的“调色板”。 一个好的例子，如下所示：
```xml
@@ -689,12 +689,12 @@ public class MyClass {
```
-布局时在写`margins`和`paddings`时，你应该使用`spacing_xx`尺寸格式来布局，而不是像对待`string`字符串一样直接写值，像这样规范的尺寸很容易修改或重构，会使应用所有用到的尺寸一目了然。 这样写会非常有感觉，会使组织和改变风格或布局是非常容易。
+布局时在写 `margins` 和 `paddings` 时，你应该使用 `spacing_xx` 尺寸格式来布局，而不是像对待 `string` 字符串一样直接写值，像这样规范的尺寸很容易修改或重构，会使应用所有用到的尺寸一目了然。 这样写会非常有感觉，会使组织和改变风格或布局是非常容易。
##### 4.4.3 strings.xml
-`strings`的`name`命名使用下划线命名法，采用以下规则：`模块名+逻辑名称`，这样方便同一个界面的所有string都放到一起，方便查找。
+`strings` 的 `name` 命名使用下划线命名法，采用以下规则：` 模块名 + 逻辑名称 `，这样方便同一个界面的所有 string 都放到一起，方便查找。
| 名称 | 说明 |
| ----------------- | ------- |
@@ -709,7 +709,7 @@ public class MyClass {
##### 4.4.4 styles.xml
-`style`的`name`命名使用大驼峰命名法，几乎每个项目都需要适当的使用`style`文件，因为对于一个视图来说有一个重复的外观是很常见的，将所有的外观细节属性（`colors`、`padding`、`font`）放在`style`文件中。 在应用中对于大多数文本内容，最起码你应该有一个通用的`style`文件，例如：
+`style` 的 `name` 命名使用大驼峰命名法，几乎每个项目都需要适当的使用 `style` 文件，因为对于一个视图来说有一个重复的外观是很常见的，将所有的外观细节属性（`colors`、`padding`、`font`）放在 `style` 文件中。 在应用中对于大多数文本内容，最起码你应该有一个通用的 `style` 文件，例如：
```
```
-应用到`TextView`中:
+应用到 `TextView` 中：
```
```
-你或许需要为按钮控件做同样的事情，不要停止在那里。将一组相关的和重复`android:****`的属性放到一个通用的`style`中。
+你或许需要为按钮控件做同样的事情，不要停止在那里。将一组相关的和重复 `android:****` 的属性放到一个通用的 `style` 中。
-**将一个大的`styles.xml`文件分割成多个文件**， 你可以有多个`styles.xml` 文件。Android SDK支持其它文件，`styles.xml`这个文件名称并没有作用，起作用的是在文件里的`
```
-应用到 `TextView` 中：
+应用到`TextView`中:
```
```
-你或许需要为按钮控件做同样的事情，不要停止在那里。将一组相关的和重复 `android:****` 的属性放到一个通用的 `style` 中。
+你或许需要为按钮控件做同样的事情，不要停止在那里。将一组相关的和重复`android:****`的属性放到一个通用的`style`中。
-** 将一个大的 `styles.xml` 文件分割成多个文件 **， 你可以有多个 `styles.xml` 文件。Android SDK 支持其它文件，`styles.xml` 这个文件名称并没有作用，起作用的是在文件里的 `
```
-应用到`TextView`中:
+应用到 `TextView` 中：
```
```
-你或许需要为按钮控件做同样的事情，不要停止在那里。将一组相关的和重复`android:****`的属性放到一个通用的`style`中。
+你或许需要为按钮控件做同样的事情，不要停止在那里。将一组相关的和重复 `android:****` 的属性放到一个通用的 `style` 中。
-**将一个大的`styles.xml`文件分割成多个文件**， 你可以有多个`styles.xml` 文件。Android SDK支持其它文件，`styles.xml`这个文件名称并没有作用，起作用的是在文件里的`