首页 > 文章 > 前端

代码异味 - 非命令式函数名称

时间：2025-01-17 21:09:51 241浏览收藏

知识点掌握了，还需要不断练习才能熟练运用。下面golang学习网给大家带来一个文章开发实战，手把手教大家学习《代码异味 - 非命令式函数名称》，在实现功能的过程中也带大家重新温习相关知识点，温故而知新，回头看看说不定又有不一样的感悟！

清晰的函数命名：避免歧义，提升代码可读性

简而言之：含糊不清的函数名会隐藏其功能，令读者困惑。请使用具有描述性、面向动作的名称。

问题

函数用途不明确
认知负担增加
上下文误导
可读性降低
协作困难
功能隐藏

解决方案

使用面向动作的动词
使用描述性名称
反映函数目的
避免通用术语
提供有意义的上下文
明确表达单一职责
使动作与结果匹配

重构示例

代码异味 - 非命令式函数名称

重构 005 - 使用函数名代替注释

马克西·孔蒂耶里 2022年6月7日

标签：#javascript #初学者 #重构 #编程

背景

使用通用术语命名的函数迫使读者深入研究实现细节才能理解其功能，这会浪费时间并增加出错的概率。在使用独立函数时，命名尤为重要，因为类名无法提供额外的上下文。这与“告诉，别问”的原则直接相关。命令式的名称不会隐藏模糊的行为，而是清晰地表达操作，引导读者无需检查代码即可理解。使用描述性名称可以消除不必要的猜测，并遵循这一原则。

代码示例

错误的示例:

public String dateformatting(Date date) {
    return new SimpleDateFormat("yyyy-mm-dd").format(date);
}

public void load() {
    System.out.println("loading...");
}

正确的示例:

public String formatDate(Date date) {
    return new SimpleDateFormat("yyyy-MM-dd").format(date);
}

public void loadUserPreferences() {
    System.out.println("Loading user preferences...");
}

检测方法

[x] 手动检查

您可以通过检查函数名中是否存在模糊术语（例如 do、run、process、load 等）来检测此问题。自动代码检查工具可以标记这些模式或突出显示名称过于通用的函数。

相关概念