没有合适的资源?快使用搜索试试~ 我知道了~
Android编码规范(最新版)
需积分: 10 7 下载量 169 浏览量
2014-07-17
17:13:08
上传
评论
收藏 258KB DOC 举报
温馨提示
试读
13页
Android编码规范(最新版),开发者最基本的常识,应该掌握的规范技巧!
资源推荐
资源详情
资源评论
编码规范
介绍
1. 为什么需要编码规范?
编码规范对于程序员而言尤为重要,有以下几个原因:
一个软件的生命周期中,的花费在于维护
几乎没有任何一个软件,在其整个生命周期中,均由最初的开发人员来维护
编码规范可以改善软件的可读性,可以让程序员尽快而彻底地理解新的代码
如果你将源码作为产品发布,就需要确任它是否被很好的打包并且清晰无误,一如你
已构建的其它任何产品
命名
2. 包命名
命名规则:一个唯一包名的前缀总是全部小写的 字母并且是一个顶级域名,通
常是 ,,,,,。包名的后续部分根据不同机构各自内部的
命 名 规 范 而 不 尽 相 同 。 这 类 命 名 规 范 可 能 以 特 定 目 录 名 的 组 成 来 区 分 部 门
,项目,机器,或注册名。
例如:
com.hymobile.nloc.activities
规约:包命名必须以 com.hymobile 开始,后面跟有项目名称(或者缩写),再后
面为模块名或层级名称。
如:
com.hymobile.
项目缩写
.
模块名
com.hymobile.nloc.bookmark
如:
com.hymobile.
项目缩写
.
层级名
com.hymobile.nloc.activities
3. 类和接口 命名
命名规则:类名是个一名词,采用大小写混合的方式,每个单词的首字母大写。尽量
使你的类名简洁而富于描述。使用完整单词,避免缩写词除非该缩写词被更广泛使用,
像 , !"
接口一般要使用 #、#、等后缀
例如:
class Raster; class ImageSprite;
规约:类名必须使用驼峰规则,即首字母必须大写,如果为词组,则每个单词的首字
母也必须要大写,类名必须使用名词,或名词词组。要求类名简单,不允许出现无意
义的单词(
如
class XXXActivity)。
如:
class BookMarkAdd
正确
如:
class AddBookReadPlanActivity
错误! 应为
class BookReadPlanAdd
4. 方法的命名
命名规则:方法名是一个动词,采用大小写混合的方式,第一个单词的首字母小写,
其后单词的首字母大写。
例如:
public void run(); public String getBookName();
类中常用方法的命名:
1. 类的获取方法(一般具有返回值)一般要求在被访问的字段名前加上 get,如
getFirstName(),getLastName()。一般来说,get 前缀方法返回的是单个值,nd 前
缀的方法返回的是列表值。
2. 类的设置方法(一般返回类型为 void):被访问字段名的前面加上前缀 set,如
setFirstName(),setLastName().
3. 类 的 布 尔 型 的 判 断 方 法 一 般 要 求 方 法 名 使 用 单 词 is 或 has 做 前 缀 , 如
isPersistent(),isString()。或者使用具有逻辑意义的单词,例如 equal 或 equals。
4. 类的普通方法一般采用完整的英文描述说明成员方法功能,第一个单词尽可能采
用动词,首字母小写,如 openFile(),addCount()。
5. 构造方法应该用递增的方式写。(参数多的写在后面)。
6. toString()方法:一般情况下,每个类都应该定义 toString(),其格式为:
5. 变量命名
命名规则:第一个单词的首字母小写,其后单词的首字母大写。变量名不应以下划线
或美元符号开头,尽管这在语法上是允许的。变量名应简短且富于描述。变量名的选
用应该易于记忆,即,能够指出其用途。尽量避免单个字符的变量名,除非是一次性
的临时变量。临时变量通常被取名为 ,,$, 和 ,它们一般用于整型;
,,,它们一般用于字符型。
例如:
String bookName;
规约:变量命名也必须使用驼峰规则,但是首字母必须小写,变量名尽可能的使用名
词或名词词组。同样要求简单易懂,不允许出现无意义的单词。
如:
String bookName;
正确
如:
String bookNameString;
错误!
6. 成员变量命名
同变量命名,但不要在私有变量前添加 字样!
7. 常量命名
命名规则:类常量的声明,应该全部大写,单词间用下划线隔开。
例如:%"&'()! *+,
例如:%"-'()! *...,
例如:%/0!'! 0'1*2,
8. 异常命名
自定义异常的命名必须以 Exception 为结尾。已明确标示为一个异常。
9. layout 命名
规约:layout xml 的命名必须以 全部单词小写,单词间以下划线分割,并且使用名
词或名词词组,即使用 模块名_功能名称 来命名。
如:
knowledge_gained_main.xml
正确
如:
list_book.xml
错误!
10. id 命名
规约:layout 中所使用的 id 必须以全部单词小写,单词间以下划线分割,并且使用
名词或名词词组,并且要求能够通过 id 直接理解当前组件要实现的功能。
如:某
TextView @+id/textbookname
错误
!
应为
@+id/book_name_show
如:某
EditText @+id/textbookname
错误
!
应为
@+id/book_name_edit
11. 资源命名
规约:layout 中所使用的所有资源(如 drawable,style 等)命名必须以全部单词
小写,单词间以下划线分割,并且尽可能的使用名词或名词组,即使用 模块名 _用途
来命名。如果为公共资源,如分割线等,则直接用用途来命名
如:
menu_icon_navigate.png
正确
如:某分割线:
line.png
或
separator.png
正确
注释
3程序有两类注释:实现注释和文档注释
。 实 现 注 释 是 使 用 4566654 和 44 界 定 的 注 释 。 文 档 注 释 被 称 为 7
7由45566654界定。文档注释可以通过 工具转换成 !"文件。
1. 文件注释
所有的源文件都应该在开头有一个注释,其中列出类名、版本信息、日期和版权声明。
如下:
45
5文件名
5包含类名列表
5版本信息,版本号
5创建日期。
5版权声明
54
2. 类注释
每一个类都要包含如下格式的注释,以说明当前类的功能等。
剩余12页未读,继续阅读
资源评论
DylanAndroid
- 粉丝: 716
- 资源: 31
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功