我的气垫船充满了鳗鱼

我的“清洁代码”课程中的一个故事。课堂练习围绕游戏井字游戏的不同方面展开。

我喜欢这款游戏作为练习平台：它似乎不需要任何需求说明。

人们了解游戏，并假设他们确切地知道他们需要如何编写代码。他们中的大多数跳过设计阶段。它每次都说明开发人员是如何急于“完成工作”，而不是思考，设计然后编写代码。

最初的练习之一是开始为游戏编写代码，主要侧重于名称和操作，而不是实际使之工作。

在练习结束时，我们将复习其中一名学生的代码。它看起来像这样：

public class Game{
public Game() {
Board board = new board();
Player playerX = new Player();
Player playerO = new Player();
}
...
}

看起来足够纯真的吧？我做的练习超出了我的记忆，而且很多次Game类就这样开始了。

事情是这样的：注意游戏创建了棋盘？这意味着每个游戏都有一个新的棋盘。

您知道，在现实生活中，同一块板上会有多个游戏。如果我们实际上考虑过对Game实例和Board实例之间的关系进行建模，那将是很少的（如果要重新使用Board，则可能是多对一）。

接下来，游戏创建Player实例。由于没有说明谁管理玩家的要求，因此Game是可行的设计选择。我不会讨论它是好是坏，但它是可行的。

尽管如此，正如我们可以阅读的代码所示，我们看到Game类不仅包含Player和Board实体，而且实际上创建了它们。

现在，您是否可以将这样的游戏描述给一个不知道每个人都在玩什么的朋友？

不。您可能会这样描述：

棋盘上的两个玩家进行游戏。

虽然代码看起来像：

游戏会创建一个棋盘。然后创建玩家。

切碎单词

我在Clean Code类中反复提到的一件事是无处不在的语言的重要性。这意味着我们会在需求，设计，代码，测试，文档和操作中使用尽可能多的真实域（产品语言）中的名称和操作术语。

由于我们正在处理代码，因此您已经看到的是不和谐。我们看到模型中对象之间的关系并不像我们在现实世界中描述的那样。

当然，它可以更加基础。参加练习的许多参与者在游戏中对董事会的描述如下：

public class Game {boolean [][] multi = new int[3][3];...
}

我不了解你，但是我从未听过用“ array”这个词描述游戏。即使是开发人员。来吧，问他们。

注意你的语言

当然，英语和Java（或者您从这两种语言中获得的任何说服力）是不同的。语言固有地具有差异。

但是，当我们遇到翻译错误时会发生什么？有时，我们了解，没有造成任何伤害。有时我们最终会得到一本奇怪的匈牙利语至英语词典。

在软件中，我们最终会遇到错误。其中一些是无关紧要的。其中一些是建立在错误的假设基础上的，并得到了错误翻译的支持。

我们如何应对翻译错误？好吧，首先要承认编程是一种翻译活动，因此容易发生翻译错误。

其次，不要跳过设计。使用代码中域中的术语。

而且，还要讲讲用法故事。如果我们这样描述游戏：

棋盘上的两个玩家进行游戏。

然后，也许代码应如下所示：

public class Player {public void play(Game game) {...}
}public class Gamepublic void setBoard(Board board) {...}
}

在描述游戏时，只有少数内容可供阅读。如果您想要易于维护的设计（而不是谁愿意），则从尽可能少的翻译开始。

待会儿你会谢谢你的。

翻译自: https://www.javacodegeeks.com/2018/04/my-hovercraft-is-full-of-eels.html