Android规范

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的时候。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 219,635评论 6 508
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,628评论 3 396
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 165,971评论 0 356
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,986评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 68,006评论 6 394
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,784评论 1 307
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,475评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,364评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,860评论 1 317
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,008评论 3 338
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,152评论 1 351
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,829评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,490评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,035评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,156评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,428评论 3 373
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,127评论 2 356

推荐阅读更多精彩内容

  • written by leo.wang Android代码开发规范 1 类声明 1.1 只有一个顶级 类声明每个顶...
    Poseidon_Wang阅读 651评论 0 0
  • 1. Java基础部分 基础部分的顺序:基本语法,类相关的语法,内部类的语法,继承相关的语法,异常的语法,线程的语...
    子非鱼_t_阅读 31,645评论 18 399
  • FreeCodeCamp - Basic JavaScript 写在前面: 我曾经在进谷前刷过这一套题,不过当时只...
    付林恒阅读 16,445评论 5 28
  • Amanda叹了口气说,你真的不知道吗。我微微怔了一下,难道我该知道什么?刚要追问,手机响了起来,竟然是翊,接起来...
    关山一一阅读 604评论 0 2
  • 喜欢 阿扬小姐 喜欢就是 一串被岁月打磨光滑的珠链 在黑暗里隐...
    阿扬_阅读 112评论 0 3