zoukankan      html  css  js  c++  java
  • Android 编码规范

    编码规范对于程序员而言,尤为重要,有以下几个原因:

    一个软件的生命周期中,80%的花费在于维护;

    几乎没有任何一个软件,在其整个生命周期中,均由最初的开发来维护;

    编码规范可以改善软件的可读性,可以让程序员尽快而彻底地理解新的代码;

    如果你将源码作为产品发布,就需要确认它是否被很好的打包并且清晰无误,一如你已构建的其他任何产品;


    命名

    1.包命名

    包名规则:一个唯一的包名的前缀总是全部小写的ASCII字母并且是一个顶级域名,如com、edu、gov、net、org等。包名的后续部分根据不同机构各自内部的命名规范而不尽相同。这类命名规范需要以特定目录名的组成来区分部门,项目,模块等。

    例如:com.issmobile.sina.reader.activity-----------新浪书城项目的Activity包,在客户不做要求的情况下,尽量按这种格式命名包名。

    2.类和接口的命名

    命名规则:每个单词首字母大写,尽量简洁而富于描述。使用完整单词,避免缩写(除非缩写已被广泛使用)。

    例如: 

    Activity  ------  [xxx]Activity.java   eg:SplashActivity

    Dialog   ------  [xxx]Dialog.java      eg:LoginDialog

    Service ------- [xxx]Service.java       

    常用的工具类--[xxx]Util.java

    抽象类  ------  Abs[xxxx].java

    接口      ------  I[xxx].java

    3.方法的命名

    命名规则:第一个单词首字母小写,其后单词的首字母大写。

    类中常用方法的命名:

    类的获取方法(一般具有返回值)一般要求在被访问的字段名前加上get,如getFirstName(),getLastName()。一般来说,get前缀方法返回的是单个值,find前缀的方法返回的是列表值。

    类的设置方法(一般返回类型为void):被访问字段名的前面加上前缀 set,如setFirstName(),setLastName().

    类的布尔型的判断方法一般要求方法名使用单词 is或has 做前缀,如isPersistent(),isString()。或者使用具有逻辑意义的单词,例如equal 或equals。

    类的普通方法一般采用完整的英文描述说明成员方法功能,第一个单词尽可能采用动词,首字母小写,如openFile(),addCount()。

    构造方法应该用递增的方式写。(参数多的写在后面)。

    toString()方法:一般情况下,每个类都应该定义toString()。

    4.变量命名

    命名规则:第一个单词首字母小写,其后单词首字母大写。尽量避免单个字符的变量名,除非是一次性的临时变量。临时变量通常被取名为i、j、k,一般用于整型;c、d、e,一般用于字符型。

    5.成员变量的命名

    命名规则:同变量命名,但不要在私有变量前添加m字样。

    6.常量命名

    命名规则:类常量的声明,应该全部大写,单词间用下划线隔开。

    例如:static final int MIN_WIDTH = 4 ;

          static final int MAX_WIDTH = 999;

    7.异常命名

    命名规则:自定义异常的命名必须以Exception为结尾,用以明确表示为一个异常。

    8.layout命名

    命名规则:layout的xml文件命名必须全部单词小写,单词之间以下划线分隔。

    例如:activity的布局文件-------activity_[xxx].xml

             布局文件引用的文件-----layout_[xxx].xml

             dialog的布局文件---------dialog_[xxx].xml

             adapter item      ---------item_[xxx].xml

    9.id命名

    命名规则:控件id的命名由控件名和作用拼成,标识控件名和作用的第一个单词首字母小写,其后单词首字母大写,用下划线连接([控件名]_[作用])。

    例如:editText_userName

          textView_message

          button_login

    10.资源命名

    命名规则:res中的所有资源(如drawable,string等)命名必须全部单词小写,单词间以下划线分隔


    注释

    Java程序有两类注释:实现注释(implementation comments)和文档注释(document comments)。

    实现注释使用/*...*/ 和 // 。

    文档注释使用/**...*/,文档注释可以通过javadoc工具转换生成HTML文件

    1.文件注释

    所有源文件都应该在开头有一个注释,其中列出类名、版本信息、日期和版权声明。

    /*

    * 文件名

    * 包含类名列表

    * 版本信息,版本号

    * 创建日期。

    * 版权声明

    */

    2.类注释

    每一个类都应该包含如下格式的注释,以说明当前类的功能等

    /**

    *  类名

    *  @author 作者 <br/>

    *      实现的主要功能。

    *      创建日期

    *      修改者,修改日期,修改内容。

    */

    3. 方法注释

    每一个方法都应该包含如下格式的注释,包括当前方法的用途,当前方法参数的含义,当前方法的返回值的内容和抛出异常的列表。

    /**

    *

    *  方法的一句话概述

    *  <p>方法详述(简单方法可不必详述)</p>

    *  @params 说明参数含义

    *  @return 说明返回值含义

    *  @throws IOException 说明发生此异常的条件

    *  @throws NullPointerException 说明发生此异常的条件

    */

    4.类成员变量和常量注释

    成员变量和常量要使用java doc形式的注释说明当前变量或常量的含义。

    /**

    *  XXXX含义

    */

    5.其他注释

    方法内部的注释如果需要多行使用/*…*/形式,如果单行使用//…形式注释。方法内部不要使用java doc注释。


    常用规范

    1.空行

    尽量使用空行将逻辑相关代码段分隔开,以提高可读性

    下列情况应该总是使用空行:

    a.   一个源文件的两个片段(section)之间

    b.   类声明和接口声明之间

    c.    两个方法之间

    d.   方法内的局部变量和方法的第一条语句之间

    e.   一个方法内的两个逻辑段之间,用以提高可读性

    2.方法

    一个方法尽量不要超过30行,如果方法太长,说明当前方法业务逻辑已经非常复杂,那么就需要进行方法拆分,请尽量确保每个方法只作一件事。

    3.参数和返回值

    一个方法的参数尽可能的不要超过4个!

    如果一个方法返回的是一个错误码,请使用异常!!

    尽可能不要使用null, 替代为异常 或者使用空变量 如返回 List 则可以使用Collections.emptyList()

    4.神秘的数

    代码中不允许出现单独的数字,字符!如果需要使用数字或字符,则将它们按照含义封装为静态常量!(for语句中除外)

    5.控制语句

    判断中如有常量,则应将常量置于判断式的右侧。如:

    if ( true == isAdmin())...

    尽量不使用三目条件的嵌套。

    所有if 语句必须用{}包括起来,即便是只有一句:

    if (true){

    //do something......

    }

    if (true)

    i = 0; //不要使用这种

    对于循环:

    尽量避免如下方式


    while(index < products.getCount()){

    //每此都会执行一次getCount()方法,

    //若此方法耗时则会影响执行效率

    //而且可能带来同步问题,若有同步需求,请使用同步块或同步方法

    }


    推荐方式


    //将操作结构保存在临时变量里,减少方法调用次数

    final int count = products.getCount();

    while(index < count){

    }


    6.异常的捕捉处理

    通常的思想是只对错误采用异常处理:逻辑和编程错误,设置错误,被破坏的数据,资源耗尽,等等。

    通常的法则是系统在正常状态下以及无重载和硬件失效状态下,不应产生任何异常。

    最小化从一个给定的抽象类中导出的异常的个数。对于经常发生的可预计事件不要采用异常。不要使用异常实现控制结构。

    若有finally 子句,则不要在try 块中直接返回,亦不要在finally 中直接返回。

    7.访问控制

    若没有足够理由,不要把实例或类变量声明为公有。通常,实例变量无需显式的设置(set)和获取(gotten),通常这作为方法调用的边缘效应 (side effect)而产生。 

    一个具有公有实例变量的恰当例子,是类仅作为数据结构,没有行为。亦即,若你要使用一个结构(struct)而非一个类(如果java 支持结构的话),那么把类的实例变量声明为公有是合适的。

    8.变量赋值

    避免在一个语句中给多个变量赋相同的值。它很难读懂。例如:

    fooBar.fChar = barFoo.lchar = 'c';

    不要将赋值运算符用在容易与相等关系运算符混淆的地方。例如:

    if (c++ = d++) {        // AVOID! (Java disallows)

          ...

    }

    应该写成

    if ((c++ = d++) != 0) {

        ...

    }

    不要使用内嵌(embedded)赋值运算符试图提高运行时的效率,这是编译器的工作。例如:

    d = (a = b + c) + r;        // AVOID!

    应该写成

    a = b + c;

    d = a + r;

    9.圆括号

    一般而言,在含有多种运算符的表达式中使用圆括号来避免运算符优先级问题,是个好方法。

    即使运算符的优先级对你而言可能很清楚,但对其他人未必如此。你不能假设别的程序员和你一样清楚运算符的优先级。

    if (a == b && c == d)     // AVOID!

    if ((a == b) && (c == d))  // RIGHT

    10.返回值

    设法让你的程序结构符合目的。例如:

    if (booleanExpression) {

       return true;

    } else {

       return false;

    }

    应该代之以如下方法:

    return booleanExpression

    类似地:

    if (condition) {

          return x;

    }

    return y;

    应该写做:

    return (condition ? x : y);

    11.条件运算符“?”前的表达式

    如果一个包含二元运算符的表达式出现在三元运算符" ? : "的"?"之前,那么应该给表达式添上一对圆括号。例如:  

    (x >= 0) ? x : -x

  • 相关阅读:
    隐藏QQ全部图标,隐藏QQ全部信息
    发放腾讯微博邀请,先到先得、
    关于“5005: 优化字节代码时发生未知错误。”的处理办法
    端口
    xmldocument
    MasterPage
    asp.net ajax
    mysqladmin 设置用户名初始密码报错you need the SUPER privilege for this operation
    实践SSH通道链接国外服务器访问受限网站
    转载 实践与分享:Windows 7怎么获取TrustedInstaller权限【图文教程】
  • 原文地址:https://www.cnblogs.com/loaderman/p/7123662.html
Copyright © 2011-2022 走看看