Java代码规范

一、为什么要有编码规范(Why Have Code Conventions)
编码规范对于程序员而言尤为重要,有以下几个原因:

  • 一个软件的生命周期中,80%的花费在于维护 - 几乎没有任何一个软件,在其整个生命周期中,均由最初的开发人员来维护 - 编码规范可以改善软件的可读性,可以让程序员尽快而彻底地理解新的代码 - 如果你将源码作为产品发布,就需要确任它是否被很好的打包并且清晰无误,一如你已构建的 其它任何产品。为了执行规范,每个软件开发人员必须一致遵守编码规范
    二Java 源文件(.java文件)
    每个 Java 源文件都包含一个单一的公共类或接口。若私有类和接口与一个公共类相关联,可以 将它们和公共类放入同一个源文件。公共类必须是这个文件中的第一个类或接口。
    Java 源文件还遵循以下规则:
    1 开头注释,其中列出类名、版本信息、日期和版权 声明
    例如:
Paste_Image.png

2 包和引入语句
在多数 Java 源文件中,第一个非注释行是包语句。在它之后可以跟引入语句。例如:
package java.awt;
import java.awt.peer.CanvasPeer;
3 类和接口声明
下表描述了类和接口声明的各个部分以及它们出现的先后次序。

Paste_Image.png

三、排版规范
1、4 个空格常被作为缩进排版的一个单位。
2、行长度
尽量避免一行的长度超过 80 个字符,因为很多终端和工具不能很好处理。
注意:用于文档中的例子应该使用更短的行长,长度一般不超过 70 个字符。
3、 换行
当一个表达式无法容纳在一行内时,可以依据如下一般规则断开之:

  • 在一个逗号后面断开
  • 在一个操作符前面断开
  • 宁可选择较高级别(higher-level)的断开,而非较低级别(lower-level)的断开
  • 新的一行应该与上一行同一级别表达式的开头处对齐
  • 如果以上规则导致你的代码混乱或者使你的代码都堆挤在右边,那就代之以缩进 8 个空格。
    以下是断开方法调用的一些例子:
Paste_Image.png

以下是两个断开算术表达式的例子。前者更好,因为断开处位于括号表达式的外边,这是个较高 级别的断开。

Paste_Image.png

以下是两个缩进方法声明的例子。前者是常规情形。后者若使用常规的缩进方式将会使第二行和 第三行移得很靠右,所以代之以缩进 8 个空格
//CONVENTIONAL INDENTATION someMethod(int anArg, Object anotherArg, String yetAnotherArg, Object andStillAnother) { ... }
//INDENT 8 SPACES TO AVOID VERY DEEP INDENTS private static synchronized horkingLongMethodName(int anArg, Object anotherArg, String yetAnotherArg, Object andStillAnother) { ... }
以下是两个缩进方法声明的例子。前者是常规情形。后者若使用常规的缩进方式将会使第二行和 第三行移得很靠右,所以代之以缩进 8 个空格

Paste_Image.png

四、语句
1、每行至多包含一条语句
int a; int b;(这样的代码最好不要出现)
2、复合语句是包含在大括号中的语句序列,形如"{ 语句 }"。例如下面各段。

  • 被括其中的语句应该较之复合语句缩进一个层次
  • 左大括号"{"应位于复合语句起始行的行尾;右大括号"}"应另起一行并与复合语句首行对齐。
  • 大括号可以被用于所有语句,如果是单个语句,最好也是用大括号,这样便于添加语句而无需担心由于忘了加括号而引入 bug。
    3、if语句的格式:
Paste_Image.png

五、空行
1 空行,空行将逻辑相关的代码段分隔开,以提高可读性。
下列情况应该总是使用两个空行:

  • 一个源文件的两个片段(section)之间 - 类声明和接口声明之间
    下列情况应该总是使用一个空行:
  • 两个方法之间
  • 方法内的局部变量和方法的第一条语句之间
  • 一个方法内的两个逻辑段之间,用以提高可读性
    六、命名规范
Paste_Image.png

·参考文献《Java 语言编码规范》

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

推荐阅读更多精彩内容