Android编码规范

潇湘剑雨 · · 221 次点击 · · 开始浏览    
这是一个创建于 的文章,其中的信息可能已经有所发展或是发生改变。

目录介绍

  • 1.命名
  • 1.为什么需要编码规范
  • 2.包命名
  • 3.类和接口命名
  • 4.方法的命名
  • 5.变量命名
  • 6.成员变量命名
  • 7.常量命名
  • 8.异常命名
  • 9.layout 命名
  • 10.id 命名
  • 11.资源命名
  • 2.注释
  • 1.文件注释
  • 2.类注释
  • 3.方法注释
  • 4.类成员变量和常量注释
  • 5.其他注释
  • 6.XML注释
  • 3.代码风格
  • 1.缩进
  • 2.空行
  • 3.行宽
  • 4.其他问题说明
  • 4.1 版本更新情况
  • 4.2 参考链接
  • 4.2 个人博客

0.备注

1.命名

1.为什么需要编码规范?

  • 编码规范对于程序员而言尤为重要,有以下几个原因:
    • 一个软件的生命周期中,80%的花费在于维护
    • 几乎没有任何一个软件,在其整个生命周期中,均由最初的开发人员来维护
    • 编码规范可以改善软件的可读性,可以让程序员尽快而彻底地理解新的代码
    • 如果你将源码作为产品发布,就需要确任它是否被很好的打包并且清晰无误,一如你已构建的其它任何产品

2.包命名

  • 命名规则:

    • 一个唯一包名的前缀总是全部小写的ASCII 字母并且是一个顶级域名
    • 通常是com.edu.gov.mil.net.org包名的后续部分根据不同机构各自内部的命名规范而不尽相同
    • 这类命名规范可能以特定目录名的组成来区分部门 (department) ,项目(project),机器(machine),或注册名(login names)。
  • 例如: com.ycbjie.player

  • 规约:包命名必须以com.ycbjie开始,后面跟有项目名称(或者缩写),再后面为模块名或层级名称。

    • 如:com.ycbjie.项目缩写.模块名 com.ycbjie.player.bookmark
    • 如:com.ycbjie.项目缩写.层级名 com.ycbjie.player.activities
  • 模块包命名的含义

    • activity 放activity相关的文件
    • service 放Service相关的文件
    • broadcast 放广播接收者相关的文件
    • fragment 放fragment相关的文件
    • view 放自定义view或者view文件
    • utils 放工具类文件
    • bean/entry 放实体类文件
    • http 放请求网络文件
    • api 放服务器端提供接口的文件
    • base 放抽取公共类文件
    • cache 放缓存处理的文件
    • db 放数据库处理相关的文件
    • inter 放接口类文件
    • listener
    • adapter 放适配器adapter相关的文件
    • callback

3.类和接口命名

  • 命名规则:类名是个一名词,采用大小写混合的方式,每个单词的首字母大写
  • 尽量使你的类名简洁而富于描述,见名知意。使用完整单词,避免缩写词(除非该缩写词被更广泛使用,像 URL,HTML)
  • 接口一般要使用able、ible、er 等后缀
  • 例如: class Raster; class ImageSprite; 规约:类名必须使用驼峰规则,即首字母必须大写,如果为词组,则每个单词的首字母也必须要大写,类名必须使用名词,或名词词组。
  • 如:class BookMarkAdd 正确
  • 如:class AddBookReadPlanActivity 错误! 应为 class BookReadPlanAdd

4.方法的命名

  • 命名规则:方法名是一个动词,采用大小写混合的方式,第一个单词的首字母小写,其后单词的首字母大写
  • 例如: public void run(); public String getBookName();
  • 类中常用方法的命名:
    • 类的获取方法(一般具有返回值)一般要求在被访问的字段名前加上get,如getFirstName(),getLastName()。一般来说,get前缀方法返回的是单个值,find前缀的方法返回的是列表值。
    • 类的设置方法(一般返回类型为void):被访问字段名的前面加上前缀 set,如setFirstName(),setLastName().
    • 类的布尔型的判断方法一般要求方法名使用单词 is或has 做前缀,如isPersistent(),isString()。或者使用具有逻辑意义的单词,例如equal 或equals。
    • 类的普通方法一般采用完整的英文描述说明成员方法功能,第一个单词尽可能采用动词,首字母小写,如openFile(),addCount()。
    • 构造方法应该用递增的方式写。(参数多的写在后面)。
    • toString()方法:一般情况下,每个类都应该定义toString(),其格式为:

5.变量命名

  • 命名规则:第一个单词的首字母小写,其后单词的首字母大写

    • 变量名不应以下划线或美元符号开头,尽管这在语法上是允许的。
    • 变量名应简短且富于描述。变量名的选用应该易于记忆,即,能够指出其用途。
    • 尽量避免单个字符的变量名,除非是一次性的临时变量。临时变量通常被取名为 i,j,k,m 和 n,它们一般用于整型;c,d,e,它们一般用于字符型。
  • 规约:变量命名也必须使用驼峰规则,但是首字母必须小写,变量名尽可能的使用名词或名词词组。要求简单易懂,不允许无意义的单词。

  • 如:String bookYCName; 正确

  • 如:String bookYCNameString; 错误!

6.成员变量命名

  • 同变量命名,但不要在私有变量前添加m字样!

7.常量命名

  • 命名规则:类常量的声明,应该全部大写,单词间用下划线隔开
  • 例如:static final int MIN_WIDTH = 4;
  • 例如:static final int MAX_WIDTH = 999;
  • 例如:static final int GET_THE_CPU = 1;

8.异常命名

  • 自定义异常的命名必须以Exception为结尾。已明确标示为一个异常。

9.layout 命名

  • 规约:layout xml 的命名必须以 全部单词小写,单词间以下划线分割,并且使用名词或名词词组,即使用 模块名_功能名称 来命名。
  • 如:knowledge_gained_main.xml 正确
  • 如:list_book.xml 错误!

10.id 命名

  • 规约:layout 中所使用的id必须以全部单词小写,单词间以下划线分割,并且使用名词或名词词组,要求能够通过id直接理解当前组件要实现的功能。
  • 如:某TextView @+id/tvbookname 错误 !应为 @+id/tv_book_name
  • 如:某EditText @+id/etbookname 错误 !应为 @+id/et_book_name

11.资源命名

  • 规约:layout中所使用的所有资源(如drawable,style等)命名必须以全部单词小写,单词间以下划线分割,并且尽可能的使用名词或名词组,即使用 模块名_用途 来命名。如果为公共资源,如分割线等,则直接用用途来命名
  • 如:menu_icon_navigate.png 正确
  • 如:某分割线:line.png 或 separator.png 正确

2.注释

  • Java 程序有两类注释:
    • 实现注释(implementation comments),实现注释是使用/.../和//界定的注释。
    • 文档注释(document comments)。文档注释由/**...*/界定。文档注释可以通过javadoc 工具转换成HTML 文件。

1.文件注释

  • 所有的源文件都应该在开头有一个注释,其中列出类名、版本信息、日期和版权声明。
/*
* 文件名
* 包含类名列表
* 版本信息,版本号
* 创建日期。
* 版权声明
*/

2.类注释

  • 每一个类都要包含如下格式的注释,以说明当前类的功能等。
/**
 * <pre>
 *     author: yangchong
 *     blog  : www.ycbjie.cn
 *     time  : 2017/01/24
 *     desc  : 图片加载工具类
 *     revise: 修改备注信息
 * </pre>
 */

3.方法注释

  • 每一个方法都要包含 如下格式的注释 包括当前方法的用途,当前方法参数的含义,当前方法返回值的内容和抛出异常的列表。
/**
 * 方法的一句话概述
 * <p>方法详述(简单方法可不必详述)</p>
 * @param s 说明参数含义
 * @return 说明返回值含义
 * @throws IOException 说明发生此异常的条件
 * @throws NullPointerException 说明发生此异常的条件
 */

4.类成员变量和常量注释

  • 成员变量和常量需要使用java doc形式的注释,以说明当前变量或常量的含义 /*XXXX含义/ 或者 //XXXx含义

5.其他注释

  • 方法内部的注释 如果需要多行 使用/*…… */形式
  • 如果为单行是用//……形式的注释。
  • 不要再方法内部使用 java doc 形式的注释“/……/”

6.XML注释

  • 规约:如果当前layout 或资源需要被多处调用,或公共使用的layout(若list_item),则需要在xml写明注释。要求注释清晰易懂。

3.代码风格

1.缩进

  • 规约:不允许使用Tab进行缩进,使用空格进行缩进,推荐缩进为2空格。

2.空行

  • 空行将逻辑相关的代码段分隔开,以提高可读性。
  • 下列情况应该总是使用空行:
    • 一个源文件的两个片段(section)之间
    • 类声明和接口声明之间
    • 两个方法之间
    • 方法内的局部变量和方法的第一条语句之间
    • 一个方法内的两个逻辑段之间,用以提高可读性
  • 规约:通常在 变量声明区域之后要用空行分隔,常量声明区域之后要有空行 分隔,方法声明之前要有空行分隔。

3.行宽

  • 无特别规定,因为现在的显示器都比较大,所以推荐使用120进行设置。

4.其他问题说明

4.1 版本更新情况

  • v1.0.0 2016年11月19日
  • v1.0.1 2017年1月17日
  • v1.0.2 2018年2月8日

4.2 参考链接

  • 阿里编码规范文档,可以直接去下载看看,强烈建议程序员认真看看。真心非常不错

4.2 个人博客

本文来自:开源中国博客

感谢作者:潇湘剑雨

查看原文:Android编码规范

221 次点击  
加入收藏 微博
暂无回复
添加一条新回复 (您需要 登录 后才能回复 没有账号 ?)
  • 请尽量让自己的回复能够对别人有帮助
  • 支持 Markdown 格式, **粗体**、~~删除线~~、`单行代码`
  • 支持 @ 本站用户;支持表情(输入 : 提示),见 Emoji cheat sheet