7月 14 2015

Android-代码规范

1 代码格式模板

在 Eclipse 的 Preferences 中，选择 Java —> Code Style —> Formatter

2 严格注释

1.1基本原则

注释应该增加代码的清晰度。代码注释的目的是要使代码更易于被其他开发人员等理解。

保持注释的简洁。

注释信息不仅要包括代码的功能，还应给出原因。

除变量定义等较短语句的注释可用行尾注释外，其他注释当避免使用行尾注释。

2.2 类、接口的注释

在类、接口定义之前当对其进行注释，包括类、接口的目的、作用、功能、继承于何种父类，实现的接口、实现的算法、使用方法等。(类注释请参照，项目中统一的注释模板，团队成员统一将 IDE 设置为统一的类注释模板)

/**
 * 类相关功能说明
 * 
 * @Description: 说明
 * 
 * @author: 作者
 * @date: 2014-03-27 下午7:54:01
 * @version: 1.0
 */
public class StringUtil { 
⋯ 
}

2.3 方法的注释

依据标准JavaDoc规范对方法进行注释，以明确该方法功能、作用、各参数含义以及返回值等。复杂的算法用/**/在方法内注解出。

参数:注释时当注明其取值范围等

返回值:当注释出失败、错误、异常时的返回情况。

异常:当注释出什么情况、什么时候、什么条件下会引发什么样的异常

方法注释示例

/**
  * @param 参数名1
  * 参数1意义
  * @param 参数名2
  * 参数2意义
  * @return
  * return说明
  * @exception 异常类型1，异常类型2
  * 异常说明1，异常说明2
  * @author: 作者
  * @date: 2014-03-27 下午7:54:01
  */
public ResultSet executeQuery(String sql) throws SQLException{     //Statement和SQL语句都不能为空 
    if(null != stmt && !StringUtil.isEmpty(sql)){ 
        //返回查询执行结果 
        return stmt.executeQuery(sql); 
    } 
    return null; 
}

2.4 变量，关键代码的注释

根据需要选择单行注释  //
或者多行注释 /**
            * 注释
            */

核心功能必须添加注释，详细说明逻辑的实现细节

复杂条件判断时，必须添加注释

应对重要的变量加以注释，以说明其含义

If else switch 必须添加注释等

2.5 复杂的布局文件的注释

3 类命名规范

类（classes）：名词，采用大驼峰命名法。

Activity类以AC_为前缀。如：AC_Main

Fragment类以FG_为前缀。如：FG_MedicineBase

公共方法类 Utils_为前缀。如：Utils_File

Service类以Service_为前缀标识。如Service_Play

Bean类普通bean对象以BN为前缀
`如：BN_Chat，http请求的bean对象以HM为前缀。如：HM_CommonAsk`

Adapter类以AD_为前缀

API接口实现类以API_为前缀

自定义view 以CV_为前缀
命名的名称不允许有 myListView 等毫无意义的命名

4 id 命名

规约：命名模式为：view缩写_模块名称_view的逻辑名称, layout 中所使用的id必须以全部单词小写，单词间以下划线分割，并且使用名词或名词词组，并且要求能够通过id直接理解当前组件要实现的功能。

如：某TextView @+id/textbookname 错误 , 应为 @+id/tv_name_show

如：某EditText @+id/textbookname 错误 ,应为 @+id/et_name

5 变量参数命名

view 的命名：为了区分view与其他普通变量，集合等变量的区别，方便大家快速定位哪个是view 的。

JAVA类中的View的命名遵循和布局文件中的ID 一致，都已小写字母 + 下划线 + 小写字母的方式命名。
普通的变量：还是遵循驼峰式命名规范已小写字母m开头
     如：String title；    
常量统一大写 + 下划线 + 大写+ 下划线

6. layout 命名

规约：layout xml 的命名必须以全部单词小写，单词间以下划线分割，并且使用名词或名词词组，即使用模块名_功能名称来命名。

如： FG_FreeAskMedicine 用到的布局文件命名为fg_freeaskmedicine.xml 正确

7. 资源命名

规约：layout中所使用的所有资源（如drawable,style等）命名必须以全部单词小写，单词间以下划线分割，并且尽可能的使用名词或名词组，即使用模块名_用途来命名。如果为公共资源，如分割线等，则直接用用途来命名

如：menu_icon_navigate.png 正确

如：某分割线：line.png 或 separator.png 正确

OnCreate 思维改变生活