Android平台java编程规范

来源:互联网 发布:360家庭网络修复在哪里 编辑:程序博客网 时间:2024/06/11 12:08

不要忽略异常

不要捕获通用的异常

不使用finalizers


导入(import)

导入具体使用的类(java标准库和单元测试代码除外)

导入顺序

   1. Android imports

   2. Imports from third parties (com, junit, net, org)

   3. java and javax


注释

每个文件最开始写明版权说明

然后在类或者接口定义前说明功能

每个类和重要的公共方法必须包括至少一行的注释,以一个第三人称的描述性动词开始


简短的方法

尽量保证方法简洁,一次做一件事。如果一个方法超过40行,考虑将它拆分


本地变量

尽量减少本地变量的作用范围


缩进

代码块总是使用4个空格,永远不使用tab

对于换行的缩进,使用8个空格


字段名

非公开、非静态的字段名以m开始

静态字段名使以s开始

其他字段名以小写字母开始

常量使用全大写加下划线方式命名


大括号

大括号不独立成行

class MyClass {

    int func() {

        if (something) {

            // ...

        } else if (somethingElse) {

            // ...

        } else {

            // ...

        }

    }

}


行长度

每行代码最长为100个字符

import行除外


Java 1.5 注释(Annotations)

@Deprecated

使用不推荐的元素时必须添加

@Override

重载父类函数时必须添加

@SuppressWarnings

消除警告,与TODO注释连用


缩写

按每个单词的首字母大写的原则,即使单词本身是缩写词

Good            Bad

XmlHttpRequest  XMLHTTPRequest

getCustomerId   getCustomerID


TODO 格式

对于临时、短期的解决方案或者不够完美的代码使用


日志

使用Log类记录日志

有以下几个级别ERROR、WARNING、INFORMATIVE、DEBUG、VERBOSE


测试规则


0 0
原创粉丝点击