Android代码风格

良好的代码风格不仅能提高可读性，也能提高程序的维护性。
1、注释规范：
原则：
1）简洁：避免注释的多义性；
2）一致：描述性注释先于代码创建，解释性注释在开发过程中创建，提示性注释在代码完成之后创建。修改代码的要修改相应的注释，以保证代码与注释的同步；
3）统一：整个应用程序中，要使用具有抑制的标点和结构的样式来构造注释；
4）就近：注释要与其描述的代码相邻，不能放在下方；
5）适量：合理的注释与程序代码的比例大约为1:4；
6）删除无用注释：程序交付或部署之前，应该删掉临时的或无关的注释；
7）复杂的注释：当需要注释复杂的代码时，先检查代码是否需要重构，保持性能和可维护性之间的平衡；
8）多余的注释：尽量只注释功能和程序各组成部分之间的相互关系。避免每行代码都使用注释；
9）必加的注释：代码不清晰或不可移植、典型算法、代码修改处、循环和逻辑分支。
类注释规范:

/**
 * CopyRight (c)2015-xxxx: <软件版权>
 * Project: <项目工程名>
 * Module ID: <(模块)类编号，可以引用系统设计中类编号>
 * Comments: <对此类的描述，可以引用系统设计中的描述>
 * JDK version used: <JDK1.8>
 * Android SDK version used: <Android5.1>
 * NameSpace: <命名空间>
 * Author: <程序员名>
 * Create Date: <类创建日期>
 * Modified By: <修改人名>
 * Modified Date: <类修改日期>
 * Why & What id modified <修改原因描述>
 * Version: <版本号>
 * @author Administrator
 *
 */

函数注释规范

/**
 * 函  数  名：readFile
 * 功能描述：从指定的位置读取文件
 * 输入参数：<String> location,<int> mode
 * 返  回  值：boolean
 * 异        常：IOException
 * 创  建  人：Tom
 * 创建日期：2015-12-31
 * 修  改  人：Tom
 * 修改日期：2015-12-31
 */

javadoc注释规范：
注释必须写在类、域、构造函数、方法及字段（field）定义之前

    /**
     * @author <描述该段代码的作者>
     * @version <描述该段代码的版本号>
     * @param <描述该段代码的形参及其意义>
     * @return <描述该段代码的返回值>
     * @see <描述该段代码的相关链接>
     * @since <描述该段代码的所支持的版本>
     */

2、命名规范
1）包名：<前缀><项目缩写><模块名>
2）方法命名：小驼峰式命名法，第一个单词小写，尽可能使用动词，其后的单词首字母大写
3）变量命名：
a、普通变量：小驼峰式命名法，不允许出现无意义的单词。私有变量添加字符“m”作为前缀，公有或受保护的变量不需要该前缀，这样仅能通过变量名就能判断出变量的修饰属性。
b、类常量：全部大写，单词间用下划线隔开
c、异常变量：自定义异常的命名必须以Exception为结尾。
4）类和接口命名
采用大驼峰式命名法，每个单词首字母都要大写