Android规范

作者: 卓技卓品 | 来源:发表于2017-06-07 08:08 被阅读0次

    Android开发中的基本规范:

    类名/接口名/文件名

    1.命名规则:类名是个一名词,采用大小写混合的方式,每个单词的首字母大写。

    2.尽量使你的类名简洁而富于描述。使用完整单词,避免缩写词(除非该缩写词被更广泛使用,像URL,HTML)

    3.接口使用ible/able等做后缀

    4.基类统一加Base前缀;

    5. util, activity, biz, entity包下的统⼀一加包名做后缀;比如SplashActivity

    方法名

    1.方法名是一个动词,采用大小写混合的方式,第一个单词的首字母小写,其后单词的首字母大写

    变量声明

    1.变量声明每行一个,便于注释;清晰易读;

    2.声明顺序:常量》静态变量》实例变量》其他,依照公开性排序(公有变量在前)

    3.变量声明应该位于代码块开始处。类变量统一放在类顶部,类声明之后;局部变量放在起始大括号之后;

    变量命名

    1.常量全部大写,单词以下划线分割

    2.静态变量以小写s开头

    3.实例变量以小写m开头

    4.类似layoutinflater按照mLayoutInflater命名

    5.实例变量中的视图变量要加类型前缀:比如mBtnSend, mLvTreasures等等

    6.只有一个单词的单独定义(button->btn,gallery->gl,scroller->scr)

    7.多单词组成直接取全部单词首字母

    变量赋值

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

    2.不要将赋值运算符用在容易与相等关系运算符混淆的地方

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

    局部变量

    1.局部变量的作用范围应保持最小( Effective Java Item 29)。这样,增加代码的可读性和可维

    护性,降低错误的可能性。每个变量应该在最里面的代码块声明,括入变量的所有使用。

    局部变量应该先声明后使用,尽量在声明局部变量的同时初始化。如果你还没有足够的信

    息来初始化变量,你应该推迟声明,直到你需要声明它的时候。

    常量

    1.位于for循环中作为计数器值的数字常量,除了-1,0和1之外,不应被直接写入代码。

    类和接口的声明

    1.在方法名与其参数列表之前的左括号“(“间不要有空格

    2.左大括号“{“位于声明语句同行的末尾

    3.右大括号“}”另起⼀行,与相应的声明语句对齐,除非是⼀个空语句,“}”应紧跟在“{“之后

    4.方法与方法之间以空行分隔

    语句

    1.简单语句:每行只有⼀条

    2.复合语句:大括号风格和类定义类似,始于行尾,结束于单独行;

    3.返回语句:空返回不应带括号

    4. if,if-else,if else-if else语句:应该总是用大括号;

    5. for,while,do-while格式类似

    6. switch语句注意,每当一个case顺着往下执行时(因为没有break语句),通常应在break语句的位置添加注释

    空白

    1.一个紧跟着括号的关键字应该被空格分开,方法名除外

    2.空白应该位于参数列表中逗号的后面

    3.所有的二元运算符,除了“.”,应该使用空格将之与操作数分开。一元操作符和操作数之间不因该加空格,比如:负号(“-“)、自增(“++”)和自减(“–”)

    4. for语句中的表达式应该被空格分开

    5.强制转型后应该跟一个空格

    异常处理

    1.不允许忽略异常,要么处理,要么抛出;可以重新抛出自定义异常,或者妥善处理,如果可以的话

    2.不要只捕获一般异常,尽可能分别处理,便于以后维护或调试

    尽量写简短的方法

    1.这在一定程度上是可行的,方法应该保持小而直观的反应它的功能。然而得承认,长的方法有时是比较适当的,因此没有死限制放在方法的长度。如果一个方法超过40行,想想是否可以在没有危害程序结构上进行拆分。

    引用类变量和类方法

    1.避免用一个对象访问一个类的静态变量和方法。应该用类名替代。

    括号使用

    1.一般而言,在含有多种运算符的表达式中使用圆括号来避免运算符优先级问题是个好方法,你不能假设别的程序员和你一样清楚运算符的优先级。

    2.如果一个包含二元运算符的表达式出现在三元运算符” ? : “的“?”之前,那么应该给表达式添上一对圆括号。例如:(x >= 0) ? x : -x;

    返回值

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

    if (booleanExpression) {

    return true;

    } else {

    return false;

    }

    应该代之以如下方法:

    return booleanExpression;

    类似地:

    if (condition) {

    return x;

    }

    return y;

    应该写做:

    return (condition ? x : y);

    特殊注释

    1.在注释中使用XXX来标识某些未实现(bogus)的但可以工作(works)的内容。用FIXME来标识某些假的和错误的内容。

    2.没用的TODO及时删除,尤其是写try catch的时候。

    相关文章

      网友评论

        本文标题:Android规范

        本文链接:https://www.haomeiwen.com/subject/gmkofxtx.html