解决打包Android Studio Gradle Issue:

2016-01-25  本文已影响731人  EvilsoulM

猫眼android技术开发规范文档

书写规范

编码

编码方式统一用UTF-8. Android Studio默认已是UTF-8，只要不去改动它就可以了。
![18:43:47.jpg](http://ww3.sinaimg.cn/large/006tNbRwjw1f5rbb59dtej30hs088my9.jpg =600x)

缩进统一为4个空格

将Tab size设置为4则可以保证tab键按4个空格缩进。另外，不要勾选上Use tab character，可以保证切换到不同tab长度的环境时还能继续保持统一的4个空格的缩进样式。
![18:26:38.jpg](http://ww4.sinaimg.cn/large/006tNbRwjw1f5ratbmurmj318k0modjm.jpg =600x)

空行

当一个表达式无法容纳在一行内时，可换行显示，另起的新行用8个空格缩进。

someMethod(longExpression1, longExpression2, longExpression3,
        longExpression4, longExpression5);

一行声明一个变量，不要一行声明多个变量，这样有利于写注释。

private String param1; // 参数1 private String param2; // 参数2

行宽设置为100，设置格式化时自动断行到行宽位置。

![09:58:42.jpg](http://ww3.sinaimg.cn/large/006tNbRwjw1f5s1r41fjfj30go071jsf.jpg =600x)

使用快捷键进行代码自动格式化。

Windows：CTRL+ALT+L
Mac：OPTION+COMMAND+L

其他

命名规范

包命名

域名反写+项目名称+模块名称，全部单词用小写字母。例如：

com.sankuai.movie.account

类名和接口命名

使用大驼峰规则，用名词或名词词组命名，每个单词的首字母大写。
以下为几种常用类的命名：

方法命名

使用小驼峰规则，用动词命名，第一个单词的首字母小写，其他单词的首字母大写。
以下为几种常用方法的命名：

自定义异常必须以Exception结尾

常量命名

全部为大写单词，单词之间用下划线分开。

public final static int PAGE_SIZE = 20;

变量命名

范围描述+}意义描述+类型描述的组合，用驼峰式，首字母小写。

private Button loginBtn;

控件变量中的常见组件缩写

（这个缩写方式需要改进）

控件 缩写 控件 缩写
TextView txt EditText edt
Button btn ImageButton ibtn
ImageView img ListView list
RadioGroup group RadioButton rbtn
ProgressBar progress SeekBar seek
CheckBox chk Spinner spinner
TableLayout table TableRow row
LinearLayout llayout RelativeLayout rlayout
ScrollView scroll SearchView search
TabHost host TabWidget widget

ps：控件变量添加组件缩写的前缀时，顺序在所有者前缀之后，例如：
全局名称mBtnNext；局部名称btnNext

控件id命名

控件缩写_ {范围_}意义，范围可选，只在有明确定义的范围内才需要加上。

 <!-- 这是标题栏的标题 -->
 <TextView
     android:id="@+id/txt_header_title"
     ... />

 <!-- 这是登录按钮 -->
 <Button
    android:id="@+id/btn_login"
    ... />

layout命名

组件类型_{范围_}功能，范围可选，只在有明确定义的范围内才需要加上。
以下为几种常用的组件类型命名：

strings命名

类型_{范围_}功能，范围可选。
以下为几种常用的命名：

color命名

前缀{_控件}{_范围}{_后缀}，控件、范围、后缀可选，但控件和范围至少要有一个。

drawable的命名

前缀{_控件}{_范围}{_后缀}，控件、范围、后缀可选，但控件和范围至少要有一个。

动画文件命名

动画类型_动画方向。

注释规范

文件头注释

文件顶部统一添加版权声明，声明的格式如下：

/**
* Copyright (c) 2015. Keegan小钢 Inc. All rights reserved.
*/

类和接口注释

类和接口统一添加javadoc注释，格式如下：

/**
* 类或接口的描述信息
*
* @author ${USER}
* @date ${DATE}
*/

方法注释

下面几种方法，都必须添加javadoc注释，说明该方法的用途和参数说明，以及返回值的说明。

/**
* 登录
*
* @param loginName 登录名
* @param password  密码
* @param listener  回调监听器
*/
public void login(String loginName, String password, ActionCallbackListener<Void> listener);

变量和常量注释

下面几种情况下的常量和变量，都要添加注释说明，优先采用右侧//来注释，若注释说明太长则在上方添加注释。

public static final int TYPE_CASH = 1; // 现金

参考资料

上一篇下一篇

猜你喜欢

热点阅读