代码异味 - 非命令式函数名称
知识点掌握了,还需要不断练习才能熟练运用。下面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 等)来检测此问题。 自动代码检查工具可以标记这些模式或突出显示名称过于通用的函数。
相关概念
- 命名
难度等级
[x] 初学者
为什么一一对应很重要
函数名与其功能之间应存在清晰的一一对应关系。 破坏这种对应关系会迫使开发人员检查代码细节以理解上下文,从而降低调试、代码审查和扩展的速度。
人工智能方面
人工智能工具有时会在不理解领域知识的情况下生成通用的函数名。 使用 AI 时,务必指定函数名要具有描述性且面向动作。
人工智能检测
人工智能模型可以通过将函数签名与预定义的命名最佳实践进行比较来帮助检测不明确的名称。 将人工智能与人工代码审查相结合可以获得最佳效果。
动手实践!
记住:人工智能助手也会出错
| 无明确指令 | 有明确指令 |
|---|---|
| ChatGPT | ChatGPT |
| Claude | Claude |
| Perplexity | Perplexity |
| Copilot | Copilot |
| Gemini | Gemini |
结论
函数名不仅仅是标签;它们是与读者之间的约定。 不明确的名称会破坏此约定并导致混乱。 描述性且面向动作的名称简化了沟通,并使代码更易于维护和扩展。
相关链接

代码气味 33 - 缩写 马克西·孔蒂耶里 2020年11月24日 标签:#哎呀 #codenewbie #编程 #教程
代码气味 153 - 名称过长 马克西·孔蒂耶里 2022年7月29日 标签:#javascript #webdev #初学者 #编程
代码气味 38 - 抽象名称 马克西·孔蒂耶里 2020年11月30日 标签:#哎呀 #codenewbie #命名 #webdev
代码气味 174 - 属性中的类名 马克西·孔蒂耶里 2022年10月29日 标签:#javascript #webdev #初学者 #编程
名字到底是什么? — 第一部分:探索 马克西·孔蒂耶里 2021年2月9日 标签:#codenewbie #教程 #webdev #哎呀
名字到底是什么 - 第二部分康复 马克西·孔蒂耶里 2021年5月23日 标签:#教程 #codenewbie #编程 #webdev
免责声明
代码气味是我的观点。
制作人员
图片来自 Unsplash 上的 British Library
函数名应为动词或动词短语,且必须有意义。
罗伯特·C·马丁

软件工程精彩名言 马克西·孔蒂耶里 2020年12月28日 标签:#codenewbie #编程 #引号 #软件
本文是代码气味系列的一部分。

如何查找代码中的臭部分 马克西·孔蒂耶里 2021年5月21日 标签:#codenewbie #教程 #代码质量 #初学者
文中关于的知识介绍,希望对你的学习有所帮助!若是受益匪浅,那就动动鼠标收藏这篇《代码异味 - 非命令式函数名称》文章吧,也可关注golang学习网公众号了解相关技术文章。
初学者指南:如何轻松启动电脑步骤详解
- 上一篇
- 初学者指南:如何轻松启动电脑步骤详解
- 下一篇
- 论坛出现(2002) notconnect 怎么办?
-
- 文章 · 前端 | 10小时前 | 前端 · javascript · JavaScript DOM遍历 NodeIterator referenceNode
- JavaScript NodeIterator.referenceNode 怎样读取迭代器当前参照的节点
- 326浏览 收藏
-
- 文章 · 前端 | 10小时前 | 前端 · JavaScript Event defaultPrevented
- JavaScript Event.defaultPrevented 怎样判断事件默认行为是否已经被取消
- 391浏览 收藏
-
- 文章 · 前端 | 11小时前 | 前端 · javascript · 浏览器API · JavaScript Selection focusNode focusOffset DOM Node 文本选择
- JavaScript Selection.focusNode 怎样取得用户当前延伸选择的端点节点
- 492浏览 收藏
-
- 文章 · 前端 | 12小时前 | 前端 · javascript · JavaScript CSSOM CSSStyleSheet CSSRule parentStyleSheet cssRules parentRule
- JavaScript CSSRule.parentStyleSheet 怎样取得一条规则所属的样式表
- 323浏览 收藏
-
- 文章 · 前端 | 14小时前 | javascript · JavaScript 滚动条 Element.clientLeft 左边框
- JavaScript Element.clientLeft 怎样理解左边框宽度与滚动条占位
- 290浏览 收藏
-
- 文章 · 前端 | 15小时前 | 前端 · javascript · JavaScript Shadow DOM Event.composed
- JavaScript Event.composed 怎样判断事件能否跨越影子根边界
- 149浏览 收藏
-
- 文章 · 前端 | 15小时前 | javascript · JavaScript dom Selection anchorOffset
- JavaScript Selection.anchorOffset 怎样理解选择起点在文本与元素中的偏移
- 496浏览 收藏
-
- 文章 · 前端 | 16小时前 | javascript · JavaScript CSSStyleSheet ownerRule CSSImportRule
- JavaScript StyleSheet.ownerRule 怎样取得导入样式表对应的规则对象
- 357浏览 收藏
-
- 文章 · 前端 | 17小时前 | html · 前端 · javascript · 表单 · JavaScript id for label 表单控件 Control HTMLLabelElement
- JavaScript HTMLLabelElement.control 怎样取得标签实际关联的表单控件
- 338浏览 收藏
-
- 文章 · 前端 | 18小时前 | 前端 · javascript · JavaScript DOM遍历 TreeWalker NodeFilter whatToShow
- JavaScript TreeWalker.whatToShow 怎样区分节点类型掩码与自定义过滤器
- 223浏览 收藏
-
- 文章 · 前端 | 18小时前 | 前端 · range · javascript · JavaScript dom range 富文本 isPointInRange 节点偏移
- JavaScript Range.isPointInRange 怎样判断指定节点偏移是否落在范围内
- 145浏览 收藏
-
- 前端进阶之JavaScript设计模式
- 设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
- 543次学习
-
- GO语言核心编程课程
- 本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
- 516次学习
-
- 简单聊聊mysql8与网络通信
- 如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
- 500次学习
-
- JavaScript正则表达式基础与实战
- 在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
- 487次学习
-
- 从零制作响应式网站—Grid布局
- 本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
- 485次学习
-
- PubMedQA
- 深入了解PubMedQA生物医学问答数据集,涵盖其核心功能、使用方法及在临床决策、药物研发等场景的应用,助力提升NLP模型性能。
- 1102次使用
-
- H2O EvalGPT
- H2O EvalGPT是H2O.ai推出的开源LLM评估平台,提供详细的大模型性能排行榜、行业特定基准测试及A/B测试功能,助您快速选择最适合项目的高性能大语言模型。
- 1099次使用
-
- LMArena
- LMArena是加州大学伯克利分校推出的AI模型匿名评测平台。通过盲测投票机制,用户可对比不同大模型回答并生成实时排行榜,助力开发者优化模型及用户选择最佳AI工具。
- 1270次使用
-
- HELM
- 深入了解斯坦福推出的HELM(Holistic Evaluation of Language Models)大模型评测体系。本文解析其核心功能、安装配置步骤及应用场景,涵盖准确性、公平性、鲁棒性等多维度指标,助力开发者全面优化语言模型性能。
- 1211次使用
-
- MMBench
- MMBench是由上海人工智能实验室等机构联合推出的多模态基准测试平台,提供细粒度能力评估、大规模数据集及VLMEvalKit工具。本文详细介绍其核心功能、安装使用方法及应用场景,助力开发者全面评估多模态模型性能。
- 1058次使用
-
- JavaScript函数定义及示例详解
- 2025-05-11 502浏览
-
- 智能体安全引领产业升级——国内AI安全产品市场深度分析
- 2026-08-21 501浏览
-
- CSS变量简化按钮悬停效果技巧
- 2026-05-31 501浏览
-
- JavaScript符号类型详解与应用
- 2026-05-31 501浏览
-
- HTML剪贴板复制粘贴怎么用
- 2026-05-26 501浏览

