《Android编码规范-永兴元》由会员分享，可在线阅读，更多相关《Android编码规范-永兴元（11页珍藏版）》请在金锄头文库上搜索。
1、Android编码规范卷号20140811卷内编号密级项目名称：项目编号：codestyle 编写人员：熊岩编写日期：2014-8-11审批人员：审批日期：历史修改记录版本号修改人/日期摘要审定人/日期V1.0.熊岩/2014-08-11初稿完成介绍1. 为什么需要编码规范?编码规范对于程序员而言尤为重要，有以下几个原因： l 一个软件的生命周期中，80%的花费在于维护 l 几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护 l 编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码 l 如果你将源码作为产品发布，就需要确任它是否被很好的打包并且清晰无误，一如你已构
2、建的其它任何产品命名2. 包命名命名规则：一个唯一包名的前缀总是全部小写的ASCII 字母并且是一个顶级域名，通常是com，edu，gov，mil，net，org。包名的后续部分根据不同机构各自内部的命名规范而不尽相同。这类命名规范可能以特定目录名的组成来区分部门 (department) ，项目(project)，机器(machine)，或注册名(login names)。例如： com.hymobile.nloc.activities规约：包命名必须以com.hymobile开始，后面跟有项目名称（或者缩写）,再后面为模块名或层级名称。如：com.hymobile.项目缩写.模块名 如：c
3、om.hymobile.项目缩写.层级名 3. 类和接口 命名命名规则：类名是个一名词，采用大小写混合的方式，每个单词的首字母大写。尽量使你的类名简洁而富于描述。使用完整单词，避免缩写词(除非该缩写词被更广泛使用，像 URL，HTML) 接口一般要使用able、ible、er 等后缀例如： class Raster; class ImageSprite;规约：类名必须使用驼峰规则，即首字母必须大写，如果为词组，则每个单词的首字母也必须要大写，类名必须使用名词，或名词词组。要求类名简单，不允许出现无意义的单词（如 class XXXActivity）。如：class BookMarkAdd 正确
4、如：class AddBookReadPlanActivity错误！ 应为 class BookReadPlanAdd4. 方法的命名命名规则：方法名是一个动词，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。例如： public void run(); public String getBookName();类中常用方法的命名：1. 类的获取方法（一般具有返回值）一般要求在被访问的字段名前加上get，如getFirstName()，getLastName()。一般来说，get前缀方法返回的是单个值，find前缀的方法返回的是列表值。2. 类的设置方法（一般返回类型为voi
5、d）：被访问字段名的前面加上前缀 set，如setFirstName(),setLastName().3. 类的布尔型的判断方法一般要求方法名使用单词 is或has做前缀，如isPersistent()，isString()。或者使用具有逻辑意义的单词，例如equal 或equals。4. 类的普通方法一般采用完整的英文描述说明成员方法功能，第一个单词尽可能采用动词，首字母小写，如openFile（），addCount（）。5. 构造方法应该用递增的方式写。（参数多的写在后面）。6. toString()方法：一般情况下，每个类都应该定义toString(),其格式为：5. 变量命名命名规则：
6、第一个单词的首字母小写，其后单词的首字母大写。变量名不应以下划线或美元符号开头，尽管这在语法上是允许的。变量名应简短且富于描述。变量名的选用应该易于记忆，即，能够指出其用途。尽量避免单个字符的变量名，除非是一次性的临时变量。临时变量通常被取名为 i，j，k，m 和 n，它们一般用于整型；c，d，e，它们一般用于字符型。（全局变量在前加上小写m）例如：StringbookName;String mBookName；规约：变量命名也必须使用驼峰规则，但是首字母必须小写，变量名尽可能的使用名词或名词词组。同样要求简单易懂，不允许出现无意义的单词。如：String bookName; 正确如：Stri
7、ng bookNameString; 错误！widget缩写对应表因为widget比较常用所以特用缩写代替缩写对应如下：TextViewtvEditTextetWebViewwvImageViewivVideoViewvvMediaControllermcListViewlvGridViewgvGalleryglyButtonbtnImageButtonibCheckBoxcbRadioButtonrbSeekBarsbProgressBarpbSpinnersprSearchViewsvAnalogClockacTimePickertpDatePickerdp6. 成员变量命名同变量命名，但
8、不要在私有变量前添加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_m
9、ain.xml正确如：list_book.xml错误！10. id 命名规约：layout 中所使用的id必须以全部单词小写，单词间以下划线分割，并且使用名词或名词词组，并且要求能够通过id直接理解当前组件要实现的功能。如：某TextView +id/textbookname错误 !应为 +id/book_name_show如：某EditText +id/textbookname错误 !应为 +id/book_name_edit11. 资源命名规约：layout中所使用的所有资源（如drawable,style等）命名必须以全部单词小写，单词间以下划线分割，并且尽可能的使用名词或名词组，即使用
10、 模块名_用途 来命名。如果为公共资源，如分割线等，则直接用用途来命名如：menu_icon_navigate.png 正确如：某分割线：line.png 或 separator.png 正确注释Java 程序有两类注释：实现注释(implementation comments)和文档注释(document comments)。实现注释是使用/*.*/和/界定的注释。文档注释(被称为doc comments)由/*.*/界定。文档注释可以通过javadoc 工具转换成HTML 文件。1. 文件注释所有的源文件都应该在开头有一个注释，其中列出类名、版本信息、日期和版权声明。如下：/* * 文件名
11、 * 包含类名列表 * 版本信息，版本号 * 创建日期。 * 版权声明 */2. 类注释每一个类都要包含如下格式的注释，以说明当前类的功能等。/* * 类名 * author作者 *实现的主要功能。 *创建日期*修改者，修改日期，修改内容。*/3. 方法注释每一个方法都要包含 如下格式的注释 包括当前方法的用途，当前方法参数的含义，当前方法返回值的内容和抛出异常的列表。/*方法的一句话概述*方法详述（简单方法可不必详述）*params说明参数含义*return说明返回值含义*throwsIOException说明发生此异常的条件*throwsNullPointerException说明发生此异
12、常的条件*/4. 类成员变量和常量注释成员变量和常量需要使用java doc形式的注释，以说明当前变量或常量的含义/* XXXX含义 */5. 其他注释方法内部的注释 如果需要多行 使用/* */形式，如果为单行是用/形式的注释。不要再方法内部使用 java doc 形式的注释“/*/”，简单的区分方法是，java doc形式的注释在 eclipse中为蓝色，普通注释为绿色。6. XML注释规约：如果当前layout 或资源需要被多处调用，或为公共使用的layout（若list_item），则需要在xml写明注释。要求注释清晰易懂。7. 生成API的方法1. 选择工程，鼠标右键菜单Export
13、 ，选择Java 下面的Javadoc ，点”next” 按钮 2. Javadoc command 里选javadoc.exe 的目录，如：C:Program FilesJavajdk1.6.0_10binjavadoc.exe3. 选择生成到Javadoc 文档中的内容( 一般选public 或protected) ，选存放目录( 默认即可) ，next下一步 ,此页全默认即可，再next 下一步 。 4. 如果项目采用的是 UTF 8 的编码 ，一定要在这一页的Extra Javadoc options 中加” -encoding UTF-8 -charset UTF-8 。否则生成的网
14、页中文注释都是乱码。 点 Finish 完成5. 所有的代码注释都会被自动加入api中，所以为了让他人看懂所写代码，在编写程序代码的时候尽量加全所有可以被加入到api中的注释代码风格1. 缩进规约：不允许使用Tab进行缩进，使用空格进行缩进，推荐缩进为2空格。2. 空行空行将逻辑相关的代码段分隔开，以提高可读性。 下列情况应该总是使用空行： l 一个源文件的两个片段(section)之间l 类声明和接口声明之间l 两个方法之间l 方法内的局部变量和方法的第一条语句之间l 一个方法内的两个逻辑段之间，用以提高可读性 规约：通常在 变量声明区域之后要用空行分隔，常量声明区域之后要有空行 分隔，方法声明之前要有空行分隔。3. 行宽无特别规定，因为现在的显示器都比较大，所以推荐使用120进行设置。规约1. 方法l 一个方法尽量不要超过50行，如果方法太长，说明当前方法业务逻辑已经非常复杂，那么就需要进行方法拆分，保证每个方法只作一件事。l 不要使用 try catch 处理业务逻辑！2. 参数和返回值l 一个方法的参数尽可能的不要超过4个！l 如果一个方法返回的是一个错误码，请使用异常！l 尽可能不要使用null， 替代为异常 或者使用空变量 如返回 List 则可以使用Collections.emptyLis
