《代码整洁之道》摘录---格式

系统管理员 2022-09-30 06:12 148阅读 0赞

团队应该一致同意采用一套简单的格式规则，可以运用将这些规则自动化的工具。

代码格式关乎沟通，而沟通是专业开发者的头等大事。

或许你认为“让代码能工作”才是专业开发者的第一优先级。你今天编写的功能，极有可能在下一版本中被修改，但代码的可读性却会对以后可能发生的修改行为产生深远影响。原始代码修改之后很久，其代码风格和可读性仍会影响到可维护性和扩展性。即便代码已不复存在，你的风格和律条仍存活下来。

**向报纸学习**

看看写得很好的报纸。从上到下阅读，在顶部，有头条，告诉你故事主题。然后第一段是大纲，接着细节渐次增加。

源代码应当一样，名称简单且一目了然。源文件最顶部应该给出高层次概念和算法。细节应该往下渐次展开，直到最底层的函数和细节。

报纸有许多篇文章，多数短小精悍。假若一份报纸只登一篇长篇故事，没人会去读它。

**概念间垂直方向上的区隔**

每   一组代码行展示一条完整的思路，这些思路需要用空白行区隔开来。（国画中的留白！）

每一行都可以标识出新的独立概念 , 下面就是一个好个示例 :

package fitnesse.wikitext.widgets;

import java.util.regex.\*;

public class BoldWidget extends ParentWidget\{

public static final String REGEXP = “’’’.+?’’’”;

private static final Pattern pattern = Pattern.compile(“’’’’(.+?)’’’”,

Pattern.MULTILINE + Pattern.DOTALL);

Public BoldWidget(…) throws Exception \{

…

\}

\}

**垂直方向上的靠近**

正因为空白行隔开了概念，靠近的代码行则暗示了它们之间的紧密关系。这有助于对代码的理解。

**垂直距离**

关系密切的概念应该互相靠近。应避免迫使读者在源文件和类中跳来跳去。

变量声明尽可能靠近其使用位置。相关的函数也应遵循从上及下的思路来排列。

**垂直顺序**

被调用的函数应该放在执行调用的函数下面，建立一种自顶向下贯穿的良好信息流。

像读文章一样，最重要的概念先出来，最底层的细节最后出来。自最前面的几个函数获知要旨，而不至于迷失于细节中。

**水平方向的区隔与靠近**

空格字符可以把相关性较弱的事物分隔开。如 :

int lineSize = line.length();

lineWidthHistogram.addLine(lineSize, lineCount);

**缩进**

程序员相当依赖缩进模式来看清楚自己在什么范围工作，这样可以快速跳过与当前关注的情形无关的范围。

**团队规则**

在团队中，规则由团队说了算。好的软件系统是由一系列读起来不错的代码文件组成的，它们需要一致和顺畅的风格。不同的风格，会增加代码阅读和维护的复杂度。

发表评论取消回复

表情：

评论列表（有 0 条评论，148人围观）

还没有评论，来说两句吧...

相关阅读

相关 JavaScript 代码整洁之道

![format_png][] > 作者：alivebao > 文章地址：https://github.com/alivebao/clean-code-js >

曾经终败给现在/ 2022年11月05日 00:43/ 0 赞/ 248 阅读

相关代码整洁之道

幕布链接：[https://share.mubu.com/doc/2qVEGDxoift][https_share.mubu.com_doc_2qVEGDxoift] 命名

曾经终败给现在/ 2022年10月16日 06:24/ 0 赞/ 285 阅读

相关《代码整洁之道》摘录---对象和数据结构

6.1 数据抽象隐藏实现并非只是在变量之间放上一个函数层那么简单。类并不简单地用getter和setter将变量推向外间，而是暴露抽象接口，以便用户无需了解数据的实现

朱雀/ 2022年09月30日 06:26/ 0 赞/ 135 阅读

相关《代码整洁之道》摘录---格式

团队应该一致同意采用一套简单的格式规则，可以运用将这些规则自动化的工具。代码格式关乎沟通，而沟通是专业开发者的头等大事。或许你认为“让代码能工作”才是专

系统管理员/ 2022年09月30日 06:12/ 0 赞/ 149 阅读

相关《代码整洁之道》摘录---注释

注释的恰当用法是弥补我们在用代码表达意图时遭遇的失败。我们总无法找到不用注释就能表达自我的方法，所以总要有注释，这并不值庆贺。如果你发现自己需要写注释，再想想看是否有

你的名字/ 2022年09月30日 04:56/ 0 赞/ 148 阅读

相关代码整洁之道注释

注释 1. 不要给糟糕的代码写注释，重新写吧。 2. 好的代码根本不需要注释。 3. 注释总是一种失败，因为我们无法找到不用注释就能表达自我的方法。 4. 注释会

谁借莪１个温暖的怀抱￠/ 2022年07月13日 06:26/ 0 赞/ 254 阅读

相关 JavaScript 代码整洁之道

整洁的代码不仅仅是让人看起来舒服，更重要的是遵循一些规范能够让你的代码更容易维护，同时降低bug几率。 1. 用命名的变量代替数组下标 // bad con

古城微笑少年丶/ 2022年01月16日 14:29/ 0 赞/ 317 阅读

相关 Java代码整洁之道

使用通用工具函数 2.1 案例一现象描述：不完善的写法： thisName != null && thisName.equals(name); 更完善

我不是女神ヾ/ 2021年11月26日 10:04/ 0 赞/ 362 阅读

相关 Java代码整洁之道

11.内部函数参数尽量使用基础类型 11.1 案例一：内部函数参数尽量使用基础类型现象描述： // 调用代码 double price = 5.1D

冷不防/ 2021年11月17日 13:56/ 0 赞/ 393 阅读

相关《代码整洁之道》笔记

《代码整洁之道》笔记 ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9

素颜马尾好姑娘i/ 2021年09月29日 03:56/ 0 赞/ 687 阅读