代码整洁之道【4】--格式

一、 格式的目的

格式关乎沟通,代码格式很重要,必须严肃对待,因为你现在写的代码可能以后由其他人维护。

或许你认为“让代码工作”才是开发者的头等大事。然而,本书作者希望你抛弃这种想法。你现在所做的功能,极有可能在下一个版本中被修改,但代码的可读性却会对以后可能发生的修改产生深远的影响。

二、 垂直格式

源代码文件应该有多大?类应该有多大?短文件通常比长文件易理解,尽量让类文件代码行在500以下。

用大多数为200行、最长500行的单个文件构造出色的系统是可能的,尽管这并非不可违背的原则,也应该乐于接受。短文通常比长文件易于理解。

(1)向报纸学习

一篇好的报纸文章,内容是从上到下循序渐进的,第一段往往是故事的大纲,再往下阅读,细节才会渐次增加。

源文件也应该像读报纸那样,名称应当简单且一目了然,名称本身应该足够告诉我们是否在正确的模块中。最顶部应该给出高层次概念和算法,细节往下逐步展开。

(2)概念间垂直方向上的区隔

几乎所有代码都是从上往下读,从左往右读。每行展现一个表达式或一个子句。每组代码行展示一条完整的思路。这些思路用空白行区隔开。每个空白行都是一条线索,标识出新的独立概念。

如果抽调这两个空白行,代码的可读性会下降不少。

(3)垂直方向上的靠近

如果说空白行隔开了概念,靠近的代码则暗示了它们之间的紧密关系。所以,关系紧密的代码应该互相靠近。

举个例子,bad practice:

良好的实践:

良好的实践中,一眼就能看到这是有两个变量和一个方法的类。但是看bad practice代码的时候,要进行很大跨度的阅读才可。也间接说明了javadoc不是任何时候都是必要的。

(4)垂直距离

关系密切的概念应该互相靠近,显然,这条规则并不适用于分布在不同文件中的概念。除非有很好的理由,否则就不要把关系密切的概念放到不同的文件中。

对于那些关系密切、放置于同一源文件中的概念 ,应尽量避免读者在源文件中跳来跳去。

①变量声明

变量声明应该尽可能靠近使用位置。因为函数很短,本地变量应该在函数顶部出现。

②实体变量

实体变量应该在类的顶部声明。在设计良好的类中,它们会被大多数方法使用。

③相关函数

某个函数调用了另外一个,就应该把它们放到一起,而且调用者应尽可能放在被调用者上面。这样,程序就有了自然的顺序,极大的增强了整个模块的可读性。

④概念相关

概念相关代码应该放到一起,相关性越强,彼此之间的距离应该越短。举个例子:

这些函数有着极强的概念相关性。因为他们有着共同的命名模式,执行同一基础任务的不同变种。

⑤垂直顺序

一般而言,我们想自上而下展示函数调用依赖顺序,这样就建立了一种自顶向下贯穿代码模块的良好信息流。

三、 横向格式

一行代码应该多宽?应该尽量保持代码行短小,尽量不要让代码超过右侧屏幕。

(1)水平方向上的区隔与靠近

我们使用空格将彼此紧密相关的事物连接到一起,也用空格字符把相关性较弱的事物隔开。

①在赋值操作前后加上空格字符,加强左边和右边的分割效果。

int lineSize += 2;

+=运算符前后有空格。

②不要在函数名和左圆括号中间加空格,因为函数与其参数密切相关,如果分开,就会显得互无关系。

③函数调用括号中的参数用空格一一隔开,强调逗号,表示参数是互相分离的。

④在运算符周围加或不加空格来表示优先级。

(2)缩进

源文件是一种继承结构,而不是大纲结构。其中的信息涉及整个文件、文件中每个类、类中的方法、方法中的代码块,也涉及代码块中的代码块。这种继承结构中每一个层级都有一个范围,名称可以在其中声明,而声明和执行语句也可以在其中解释。

要让这种范围式继承结构可见,就需要缩进处理。在文件的顶层语句,例如大多数类声明,根本不缩进,类中的方法对应该类缩进一个层级。方法的实现相对方法的声明缩进一个层级。代码块的实现相对于其容器代码块缩进一个层级,以此类推。

(3)空范围

有时,while或者for语句的语句体为空,尽量不要使用这种结构,如果无法避免,就确保空范围体的缩进,用括号包围起来。

良好实践:

while (dis.read(buf, 0,  readBufferSize) != -1) {
}

bad practice:

while (dis.read(buf, 0,  readBufferSize) != -1) ;

为什么这是bad practice呢?因为很容易让人忽视掉最后的分号,误以为下面的语句在while循环里。

四、团队规则

一组开发者应该认同同一种风格,每个成员都应该采用那种风格。
记住,好的软件系统由一系列读起来不错的代码文件组成的。它们需要有一致和顺畅的风格。绝对不要使用各种不同的编码风格来编写源代码,这样会增加其复杂度。

五、附录,作者提供的格式规范code的范例

可以看到这份代码确实读起来很顺畅,让人看起来神清气爽。
满足垂直格式和横向格式中的细节。

参考
《代码整洁之道》

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

推荐阅读更多精彩内容