Android 编码规范
浏览数：26 /
时间：2015年06月11日
1.包命名
一个唯一的包名总是全部小写，构造为顶级域名com/edu/net+机构部门缩小+项目所写+模块名
例如com.tghz.gameimsdk.activity
2.类命名
类名采用驼峰式命名，大小写混合，每个单词的首字母大写，使用完整单词，避免缩写词（除非该缩写词被广泛的使用，如URL,HTML）。
类名的每个单词为名词，避免出现无意义的单词，如class BookReadPlanActivity 改为class BookReadPlan，可以采用下划线来区分。
3.接口名
接口一般要使用able,ible,er等后缀，如class Raster ，class ImageSprite。
4.方法的命名
方法名是一个动词，采用大小写混写的方式，第一个的单词的首字母小写。
例如 public void run(); public void getName();
类中常用方法的命名：
(1). 类的获取方法，一般具有返回值，则要求在被访问的字段名前加上get，如getFirstName()，getLastName()。
一般来说，get前缀方法返回的是一个值，而find前缀方法返回的是列表值。
(2).类的设置方法，一般返回类型为void，被访问的字段名前面加上前缀set。例如：setFirstName()，setLastName()。
(3).类的布尔型的判断方法一般要求方法名使用单词is或has前缀，如isPersistent()，isString()。或者使用具有逻辑意义的单词，如equal或equals。
(4).类的一般方法尽量采用完整的英文描述说明成员方法功能，第一个单词尽可能采用动词，首字母小写，如openFile(),addCount()。
(5).构造方法应该用递增方式写，参数多的写到后面。
(6).toString()方法，一般来说每个类都应该定义toString方法。
5.变量命名
采用驼峰式命名，第一个单词的首字母要小写，变量名不应以下划线或美元符号来开头，尽量避免单个字符的使用，除非是一次性的临时变量，
临时变量通常被取名i,j,k,m,n，一般用于整型，c,d,e她们用于字符型。
注意：不要在私有变量前添加m字样。
6.常量命名
类常量的声明，应该全部大写，单词间用下划线隔开。
例如：static final int MIN_WIDTH=4;
7.layout命名
layout.xml的命名必须全部小写，单词间使用下划线分隔，构造形式：模块名_功能名称。
例如某个Activity的布局文件：activity_home.xml
某个View的布局文件：view_emot_panel.xml
8.id命名
全部小写，单词间下划线隔开，并且要求能够通过id直接理解当前组件要实现的功能。
如某个TextView @+id/book_name_show，某个EditText @+id/book_name_edit。
9.资源命名
layout中的全部资源（drawable,style）单词全部小写，单词间以下划线分割，构造形式：模块名_用途。
如果为公共资源，如分割线，使用其功能来命名。
如 menu_icon_nevigate.png，
某分割线line.png改为separator.png
注释
Java中有两类注释：实现注释和文档注释。实现注释是使用/*...*/和//界定的注释。
文档注释有/**...*/界定。文档注释可以通过javadoc工具来生成HTML文件。
(1).文件注释（实现注释）
所有的源文件都应该在开头有一个注释，其中列出类名，版本信息，日期和版权声明。
如下：
每一个类都要包含如下格式的注释，以说明当前类的功能等。
要包含：当前方法的用途，当前方法参数的含义，当前方法返回值的内容和抛出异常的列表。
和常量注释（文档注释）
使用javadoc形式的注释，以说明当前变量或常量的含义。
一个唯一的包名总是全部小写，构造为顶级域名com/edu/net+机构部门缩小+项目所写+模块名
例如com.tghz.gameimsdk.activity
2.类命名
类名采用驼峰式命名，大小写混合，每个单词的首字母大写，使用完整单词，避免缩写词（除非该缩写词被广泛的使用，如URL,HTML）。
类名的每个单词为名词，避免出现无意义的单词，如class BookReadPlanActivity 改为class BookReadPlan，可以采用下划线来区分。
3.接口名
接口一般要使用able,ible,er等后缀，如class Raster ，class ImageSprite。
4.方法的命名
方法名是一个动词，采用大小写混写的方式，第一个的单词的首字母小写。
例如 public void run(); public void getName();
类中常用方法的命名：
(1). 类的获取方法，一般具有返回值，则要求在被访问的字段名前加上get，如getFirstName()，getLastName()。
一般来说，get前缀方法返回的是一个值，而find前缀方法返回的是列表值。
(2).类的设置方法，一般返回类型为void，被访问的字段名前面加上前缀set。例如：setFirstName()，setLastName()。
(3).类的布尔型的判断方法一般要求方法名使用单词is或has前缀，如isPersistent()，isString()。或者使用具有逻辑意义的单词，如equal或equals。
(4).类的一般方法尽量采用完整的英文描述说明成员方法功能，第一个单词尽可能采用动词，首字母小写，如openFile(),addCount()。
(5).构造方法应该用递增方式写，参数多的写到后面。
(6).toString()方法，一般来说每个类都应该定义toString方法。
5.变量命名
采用驼峰式命名，第一个单词的首字母要小写，变量名不应以下划线或美元符号来开头，尽量避免单个字符的使用，除非是一次性的临时变量，
临时变量通常被取名i,j,k,m,n，一般用于整型，c,d,e她们用于字符型。
注意：不要在私有变量前添加m字样。
6.常量命名
类常量的声明，应该全部大写，单词间用下划线隔开。
例如：static final int MIN_WIDTH=4;
7.layout命名
layout.xml的命名必须全部小写，单词间使用下划线分隔，构造形式：模块名_功能名称。
例如某个Activity的布局文件：activity_home.xml
某个View的布局文件：view_emot_panel.xml
8.id命名
全部小写，单词间下划线隔开，并且要求能够通过id直接理解当前组件要实现的功能。
如某个TextView @+id/book_name_show，某个EditText @+id/book_name_edit。
9.资源命名
layout中的全部资源（drawable,style）单词全部小写，单词间以下划线分割，构造形式：模块名_用途。
如果为公共资源，如分割线，使用其功能来命名。
如 menu_icon_nevigate.png，
某分割线line.png改为separator.png
注释
Java中有两类注释：实现注释和文档注释。实现注释是使用/*...*/和//界定的注释。
文档注释有/**...*/界定。文档注释可以通过javadoc工具来生成HTML文件。
(1).文件注释（实现注释）
所有的源文件都应该在开头有一个注释，其中列出类名，版本信息，日期和版权声明。
如下：
<span style="font-size:14px;"> /*
* 文件名
* 包含类名列表
* 版本信息，版本号
* 创建日期
* 版权声明
*/</span>(2).类注释（文档注释）每一个类都要包含如下格式的注释，以说明当前类的功能等。
<span style="font-size:14px;"> /**
* 类名
* @author 作者
* 实现的主要功能
* 创建日期
* 修改者，修改日期，修改内容
*/</span>(3).方法注释（文档注释）要包含：当前方法的用途，当前方法参数的含义，当前方法返回值的内容和抛出异常的列表。
<span style="font-size:14px;"> /**
* 方法的一句话概述
* 方法详述
* @param 说明参数的含义
* @return 说明返回值含义
* @throws IOException 说明此发生异常的条件
* @throws NullPointerException 说明发生此异常的条件
*/</span>(4).类成员变量和常量注释（文档注释）
使用javadoc形式的注释，以说明当前变量或常量的含义。
<span style="font-size:14px;"> /**
* 变量的含义
*/ </span> 注意：不要在方法内部使用文档注释，使用多方//或/*...*/郑重声明：本站内容如果来自互联网及其他传播媒体，其版权均属原媒体及文章作者所有。转载目的在于传递更多信息及用于网络分享，并不代表本站赞同其观点和对其真实性负责，也不构成任何其他建议。
