代码气味是经典。 它闻起来很臭，因为可能有很多情况可以对其进行编辑或改进。 大多数这些气味只是暗示可能有问题。它们本身不需要固定……（不过你应该研究一下。） 以前的代码气味 第一部分 第二部分 第三部分 第四部分 第五部分 第六部分 第七部分 第八部分 第九部分 第十部分 第十一部分 第十二部分 第十三部分 第十四部分 第十五部分 第十六部分 第十七部分 第十八部分 第十九部分 第二十部分 让我们继续... Code Smell 101 - 与布尔值的比较 与布尔值进行比较时，我们执行魔术转换并得到意想不到的结果。 TL;DR：不要与真实比较。要么你是真的，要么是假的，或者你不应该比较 问题 隐藏的铸件 最不意外的原则违反。 违反原则 Fail Fast 解决方案 使用布尔值 不要将布尔值与 混合 布尔可转换对象 语境 许多语言将值转换为布尔交叉域。 示例代码 错误的 #!/bin/bash if [ false ]; then echo "True" else echo "False" fi # this evaluates to true since # "false" is a non-empty string if [ false ] = true; then echo "True" else echo "False" fi # this also evaluates to true 正确的 #!/bin/bash if false ; then echo "True" else echo "False" fi # this evaluates to false 检测 自动 [x] Linter 可以检查明确的比较和警告。 标签 铸件 结论 将许多非布尔值用作布尔值是一种常见的行业惯例。使用布尔值时我们应该非常严格。 关系 Code Smell 69 - 生活大爆炸（JavaScript 荒谬的铸件） 更多信息 快速失败 学分 在 上拍摄的照片 迈克尔 Unsplash 如果它不起作用，那么它不起作用的速度有多快都没关系。 - 米奇·拉维拉 代码气味 102 - 箭头代码 嵌套的 IF 和 Elses 很难阅读和测试 TL;DR：避免嵌套 IF。更好：避免所有 IF 问题 可读性 解决方案 提取方法 组合布尔条件 删除意外的 IF 语境 在过程代码中，很常见的是复杂的嵌套 if。此解决方案与脚本相关的程度高于面向对象的编程。 示例代码 错误的 if (actualIndex < totalItems) { if (product[actualIndex].Name.Contains("arrow")) { do { if (product[actualIndex].price == null) { // handle no price } else { if (!(product[actualIndex].priceIsCurrent())) { // add price } else { if (!hasDiscount) { // handle discount } else { // etc } } } actualIndex++; } while (actualIndex < totalCounf && totalPrice < wallet.money); } else actualIndex++; } return actualIndex; } 正确的 foreach (products as currentProduct) addPriceIfDefined(currentProduct) addPriceIfDefined() { //Several extracts } 检测 自动 [x] 由于许多 linter 可以解析树，我们可以在编译时检查嵌套级别。 标签 可读性 复杂 结论 按照 ，我们应该让代码比我们找到的更干净。 鲍勃叔叔的建议 重构这个问题很容易。 关系 Code Smell 78 - 回调地狱 代码异味 03 - 函数太长 Code Smell 36 - Switch/case/elseif/else/if 语句 更多信息 C2 维基 扁平箭头代码 重构网 软件工程的目的是控制复杂性，而不是创造复杂性。 - 帕梅拉扎夫 Code Smell 103 - 双重封装 调用我们自己的访问器方法似乎是一个很好的封装想法。但事实并非如此。 TL;DR：不要使用 setter 和 getter，即使是私人使用 问题 二传手 吸气剂 暴露私有属性 解决方案 删除设置器 移除吸气剂 保护你的属性 语境 使用双重封装是 90 年代的标准程序。 即使是为了私人使用，我们也想隐藏实现细节。 当太多的功能依赖于数据结构和意外实现时，这隐藏了另一种气味。 例如，我们可以改变一个对象的内部表示并依赖它的外部协议。 成本/收益不值得。 示例代码 错误的 contract MessageContract { string message = "Let's trade"; function getMessage() public constant returns(string) { return message; } function setMessage(string newMessage) public { message = newMessage; } function sendMessage() public constant { this.send(this.getMessage()); // We can access property but make a self call instead } } 正确的 contract MessageContract { string message = "Let's trade"; function sendMessage() public constant { this.send(message); } } 检测 半自动 [x] 我们可以推断 getter 和 setter 并检查它们是否是从同一个对象调用的。 标签 封装 结论 双重封装是一种保护意外实现的流行想法，但它暴露的比保护的多。 关系 代码气味 37 - 受保护的属性 代码气味 28 - 二传手 代码气味 68 - 吸气剂 更多信息 堆栈交换 红迪网 信息世界 学分 雷·轩尼诗 ( ) 在 上拍摄的照片 Ray Hennessy Unsplash 封装变化的概念。 - 埃里希伽玛 代码气味 104 - 断言为真 断言布尔值会使错误跟踪更加困难。 TL;DR：除非您检查布尔值，否则不要断言 true 问题 快速失败原则 解决方案 检查布尔条件是否可以更好地重写 支持 assertEquals 语境 当断言一个布尔值时，我们的测试引擎对我们帮助不大。 他们只是告诉我们有些事情失败了。 错误跟踪变得更加困难。 示例代码 错误的 <? final class RangeUnitTest extends TestCase { function testValidOffset() { $range = new Range(1, 1); $offset = $range->offset(); $this->assertTrue(10 == $offset); // No functional essential description :( // Accidental description provided by tests is very bad } } // When failing Unit framework will show us // // 1 Test, 1 failed // Failing asserting true matches expected false :( // () <-- no business description :( // // <Click to see difference> - Two booleans // (and a diff comparator will show us two booleans) 正确的 <? final class RangeUnitTest extends TestCase { function testValidOffset() { $range = new Range(1, 1); $offset = $range->offset(); $this->assertEquals(10, $offset, 'All pages must have 10 as offset'); // Expected value should always be first argument // We add a functional essential description // to complement accidental description provided by tests } } // When failing Unit framework will show us // // 1 Test, 1 failed // Failing asserting 0 matches expected 10 // All pages must have 10 as offset <-- business description // // <Click to see difference> // (and a diff comparator will help us and it will be a great help // for complex objects like objects or jsons) 检测 半自动 [x] 如果我们在设置此条件后检查布尔值，一些 linter 会警告我们。 我们需要将其更改为更具体的检查。 标签 测试气味 结论 尝试重写您的布尔断言，您将更快地修复故障。 关系 Code Smell 101 - 与布尔值的比较 代码气味 07 - 布尔变量 更多信息 快速失败 学分 照片由 在 上拍摄 Joël de Vriend Unsplash 我终于明白了“向上兼容”是什么意思。这意味着我们可以保留我们所有的旧错误。 —— 丹尼·范·塔塞尔 代码气味 105 - 喜剧演员方法 使用专业且有意义的名称 TL;DR：不要随意或冒犯 问题 可读性 不专业的工作 解决方案 选择好的和专业的名字。 语境 我们的职业有创造性的一面。 有时我们会感到无聊并试图变得有趣。 示例代码 错误的 function erradicateAndMurderAllCustomers(); // unprofessional and offensive 正确的 function deleteAllCustomers(); // more declarative and professional 检测 半自动 [x] 我们可以有一个禁用词列表。 我们还可以在代码审查中检查它们。 名称是上下文相关的，因此对于自动 linter 来说这将是一项艰巨的任务。 命名约定应该是通用的，不应包含文化术语。 标签 命名 结论 在代码中命名事物的方式要专业。 不要通过给变量起一个愚蠢的名字来试图成为喜剧演员。 您应该编写生产代码，以便未来的软件开发人员（甚至您）应该很容易理解。 关系 代码气味 38 - 抽象名称 更多信息 名字里有什么 学分 斯图尔特·蒙罗 ( 在 上拍摄的照片 Stewart Munro) Unsplash 这种“用户是白痴，被功能所迷惑”的 Gnome 心态是一种病。如果您认为您的用户是白痴，那么只有白痴才会使用它。 - 莱纳斯·托瓦兹 软件工程名言 这就是现在的全部…… 下一篇文章将解释另外 5 种代码异味！

Keep

Winner of Noonies 2020 for the award Hacker Noon Contributor of the Year - REFACTORING.

如何找到代码中的臭味部分 [第 XXI 部分]

太長; 讀書

Company Mentioned

Maximiliano Contieri

About Author

標籤

Languages

这篇文章刊登在...