过于复杂的命名会导致混乱

TL;DR：命名很难，不要因为不必要的意外复杂性而让它变得更难。

问题

• 不清晰、误导性、含糊和不明确的名称

• 冗余术语

• 令人困惑的抽象

• 隐秘缩写

解决方案

1. 简化命名约定

2. 确保一致性

3. 避免不必要的行话

4. 根据行为使用描述性名称

5. 保持术语一致

语境

路德维希·维特根斯坦认为，许多混乱是由语言滥用引起的。

当您的名称过于复杂、混合隐喻或使用不一致的术语时，就会发生这种情况。

当你不清晰地命名类、方法或变量时，你就创建了一个其他人难以导航的语言迷宫。

这会导致错误，使维护变得更加困难，并导致团队沮丧。

示例代码

错误的

public class AbstractDataHandlerManager {
    private String dtStr;

    public void execProcessingOps(String input) {
        if (dtStr != null && !dtStr.isEmpty()) {
            // process
        }
    }
}

正确的

public class SETIProcessor {

    public void processSignal(String input) {      
            // process
        }
    }
}

检测

[X] 手册

当名称开始变长，或者当您经常看到“Abstract”、“Manager”、“Handler”、“Helper”或“Data”时，您可以检测到这种气味。

另一个标志是，您必须向其他开发人员解释名称的含义，例如在代码审查中。

标签

• 命名

等级

[X] 初学者

人工智能一代

人工智能生成器通常通过生成试图涵盖所有可能的上下文的冗长和通用名称来创建这种气味。

他们是许多领域的专家并编写代码，但除非得到指示，否则他们通常不会同时做这两件事。

人工智能检测

人工智能生成器有时可以通过简单的重构指令（例如“简化名称”或“删除冗余术语”）来修复这种气味，但很难进行更深入的上下文理解。

结论

代码中的语言混乱会导致不必要的复杂性。

使用清晰、一致和直接的命名使您的代码更易于阅读和维护。

关系

代码气味 22 - 助手

马克西·孔蒂耶里 ・ 十一月 12 '20

#哎呀 #助手 #codenewbie #初学者

代码气味 38 - 抽象名称

马克西·孔蒂耶里 ・ 2020 年 11 月 30 日

#哎呀 #codenewbie #命名 #webdev

代码气味 197 - 无偿上下文

马克西·孔蒂耶里 ・ 2023 年 2 月 21 日

#webdev #初学者 ＃编程 ＃教程

代码气味 113 - 数据命名

马克西·孔蒂耶里·22 年 1 月 5 日

#哎呀 #webdev ＃数据库 #重构

更多信息

维特根斯坦的语言混乱概念

软件是什么（有问题）

马克西·孔蒂耶里 ・2020 年 10 月 8 日

#哎呀 ＃坚硬的 #初学者 ＃设计

名字到底是什么？ — 第一部分：探索

马克西·孔蒂耶里·21 年 2 月 9 日

#codenewbie ＃教程 #webdev #哎呀

名字到底是什么 - 第二部分康复

马克西·孔蒂耶里·21 年 5 月 23 日

＃教程 #codenewbie ＃编程 #webdev

免责声明

代码味道是我的观点。

制作人员

照片由 Mimi Thian 在 Unsplash 上拍摄

清晰语言的最大敌人是不真诚。

乔治·奥威尔

软件工程精彩报价

马克西·孔蒂耶里 ・ 2020 年 12 月 28 日

#codenewbie ＃编程 ＃引号 ＃软件

本文是 CodeSmell 系列的一部分。

如何查找代码中的臭部分

马克西·康泰里 ・ 21 年 5 月 21 日

#codenewbie ＃教程 #代码质量 #初学者