Java代码风格,掌握了这些你就可以成为架构师

命名规约

1.命名符合本语言特性

Java中所有的代码元素的命名均不能以下划线或美元符号开始或结束。

2.命名体现代码元素特征

要从名字上就知道代码元素的属性是什么,有利于快速理清代码脉络。代码的命名形式分为两大类:即首字母大写UpperCamelCase和首字母小写lowerCamelCase,前者俗称大驼峰,后者俗称小驼峰。
推荐在Java命名时,以下列方式体现元素特征:
*包名统一小写,点分隔符之间有且仅有一个自然语义的英文单词。统一使用单数形式。
*抽象类命名使用Abstract或Base开头;异常类命名使用Exception结尾;测试雷鸣以它要测试的类名开始,以Test结尾。
*类型与中括号紧挨相连来定义数组。
*枚举类名带上Enum后缀,枚举成员名称需要全大写,单词间用下划线隔开。

3.命名最好望文知意

代码风格展示

1.缩进

在IDEA中设置Tab键为4个空格时,请勿勾选Use tab character;
在Eclipes中,必须勾选Insert spaces for tabs.

2.空格

空格的使用有如下约定:
(1)任何二目、三目运算符的左右两边都必须加一个空格
(2)注释的双斜线与注释内容之间有且仅有一个空格
(3)方法参数在定义和传入时,多个参数逗号后面必须加空格
(4)没有必要增加若干空格使变量的赋值等号与上一行对应位置的等号对齐
(5)如果是大括号内为空,则简洁地写成{}即可,大括号中间无需换行和空格
(6)左右小括号与括号内部地相邻字符之间不要出现空格
(7)左大括号前需要加空格

3.空行

空行用来分割功能相似、逻辑内聚、意思相近地代码片段。在方法定义之后、属性定义与方法之间、不同逻辑、不同语义、不同业务地代码之间都需要通过空行来分隔。

4.换行

在代码中需要限定每行地字符个数,以便适应显示器地宽度。约定:单行字符数不超过120个,超出则需要换行,需要遵循如下原则:
1.第二行相对第一行缩进4个空格,从第三行开始,不再继续缩进
2.运算符与下文一起换行
3.方法调用的点符号与下文一起换行
4.方法调用中的多个参数需要换行时,在逗号后换行
5.在括号前不要换行

5.方法行数限制

约定单行方法的总行数不超过80行。

控制语句

1.在if 、else、for、while、do-while等语句中必须使用大括号

即使只有一行代码,也要加上大括号

2.在条件表达式中不允许有赋值才做,也不允许在判断表达式中出现复杂的逻辑组合
3.多层嵌套不能超过3层
4.避免采用取反逻辑运算符

取反逻辑运算符不易理解

代码注释

注释三要素

1.Nothing is strange

代码中不能没有注释!

2.Less is more

首先,代码的注释一定是精华中的精华!
其次,注释要简练,不能长篇大论。
最后,一些简单方法常识性的方法无需注释

3.Advance with the times

任何对于代码的修改,都应该同时修改注释

注释格式

1.Javadoc规范

使用文档注释(/** */)的格式,方便生成文档。
这里特别强调的是枚举的注释,枚举的注释是必须要有的,因为:
1.枚举实在太特殊了,它的代码极其稳定
2.注释的内容不仅限于解释属性值的含义,还可以包括注意事项、业务逻辑
3.枚举类的删除或者修改都存在很大的风险

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

推荐阅读更多精彩内容

  • 更新时间:2016/5/13 介绍 本文档所提供的编码规范,适用于主要的Python发行版中组成标准库的Pytho...
    超net阅读 5,862评论 0 15
  • 贡献者的代码风格 下面的代码样式是严格的规则,而不是准则或建议。不符合这些规则的Android应用通常不会被接受。...
    AlexMofer阅读 751评论 0 1
  • 这篇文章讲安卓项目和代码风格指南,非常有参考价值。为了方便大家查阅,把原文翻译了一下。英文原文点这里 1. 项目指...
    Jdqm阅读 1,068评论 0 30
  • 格式规范 命名规则:规范避免单字母命名。命名应具备描述性使用驼峰式命名对象、函数和实例(首字母小写)使用帕斯卡式命...
    iOS收藏家阅读 860评论 0 0
  • 行业,地域,国别,个性。。。 难怪有思考发笑之说。 还是道德经说的好,反者道之动啊
    许中阳阅读 299评论 1 0