naming-cheatsheet函数命名指南:Action/Context模式详解
2026-01-18 10:30:40作者:秋泉律Samson
给函数起个好名字是编程中最具挑战性的任务之一!😅 一个优秀的函数名不仅能提高代码可读性,还能让团队协作更加顺畅。今天,我将为你介绍来自naming-cheatsheet项目的终极函数命名解决方案——A/HC/LC模式,这个简洁实用的命名规范将彻底改变你的编码习惯。
什么是A/HC/LC命名模式?
A/HC/LC模式是一个强大的函数命名框架,其结构为:
前缀? + 动作 (A) + 高语境 (HC) + 低语境? (LC)
这个模式的核心思想是将函数名分解为三个关键部分,确保每个函数名都能清晰传达其意图和功能。
动作(Action)部分详解
动作是函数名中最核心的部分,它直接描述了函数要执行的操作。让我们看看最常见的动作类型:
获取数据:get
get用于立即访问数据,是内部数据的快捷获取器:
function getUser(id) {
// 获取用户信息
}
设置数据:set
set用于以声明方式设置变量值:
function setUserName(name) {
// 设置用户名
}
处理事件:handle
handle常用于命名回调方法,表示处理某个动作:
function handleClickOutside() {
// 处理外部点击事件
}
语境(Context)的重要性
语境定义了函数操作的领域或数据类型。理解高语境和低语境的区别至关重要:
- 高语境(HC):强调变量的核心含义
- 低语境(LC):提供额外的细节信息
实战应用示例
让我们通过具体例子来理解这个模式:
| 函数名 | 前缀 | 动作 | 高语境 | 低语境 |
|---|---|---|---|---|
getUser |
- | get |
User |
- |
getUserMessages |
- | get |
User |
Messages |
shouldDisplayMessage |
should |
Display |
Message |
- |
前缀的妙用
前缀虽然不常用,但在特定场景下能显著增强函数名的表达力:
状态判断:is
描述当前语境的特性或状态:
const isVisible = true
const isActive = status === 'active'
条件控制:should
反映正向条件语句,通常与特定动作结合:
function shouldUpdateComponent() {
// 判断是否应该更新组件
}
命名最佳实践总结
- 保持简洁性:函数名应该简短易记
- 确保直观性:读起来要自然流畅 3 注重描述性:准确反映函数的功能
记住,好的函数命名就像好的文档——它让代码自己说话!✨
通过掌握naming-cheatsheet的A/HC/LC模式,你将能够创建出既专业又易于理解的函数名,大大提升代码质量和团队协作效率。
登录后查看全文
热门项目推荐
相关项目推荐
atomcodeClaude Code 的开源替代方案。连接任意大模型,编辑代码,运行命令,自动验证 — 全自动执行。用 Rust 构建,极致性能。 | An open-source alternative to Claude Code. Connect any LLM, edit code, run commands, and verify changes — autonomously. Built in Rust for speed. Get StartedRust099- DDeepSeek-V4-ProDeepSeek-V4-Pro(总参数 1.6 万亿,激活 49B)面向复杂推理和高级编程任务,在代码竞赛、数学推理、Agent 工作流等场景表现优异,性能接近国际前沿闭源模型。Python00
MiMo-V2.5-ProMiMo-V2.5-Pro作为旗舰模型,擅⻓处理复杂Agent任务,单次任务可完成近千次⼯具调⽤与⼗余轮上 下⽂压缩。Python00
GLM-5.1GLM-5.1是智谱迄今最智能的旗舰模型,也是目前全球最强的开源模型。GLM-5.1大大提高了代码能力,在完成长程任务方面提升尤为显著。和此前分钟级交互的模型不同,它能够在一次任务中独立、持续工作超过8小时,期间自主规划、执行、自我进化,最终交付完整的工程级成果。Jinja00
Kimi-K2.6Kimi K2.6 是一款开源的原生多模态智能体模型,在长程编码、编码驱动设计、主动自主执行以及群体任务编排等实用能力方面实现了显著提升。Python00
MiniMax-M2.7MiniMax-M2.7 是我们首个深度参与自身进化过程的模型。M2.7 具备构建复杂智能体应用框架的能力,能够借助智能体团队、复杂技能以及动态工具搜索,完成高度精细的生产力任务。Python00
项目优选
收起
deepin linux kernel
C
28
16
Claude Code 的开源替代方案。连接任意大模型,编辑代码,运行命令,自动验证 — 全自动执行。用 Rust 构建,极致性能。 | An open-source alternative to Claude Code. Connect any LLM, edit code, run commands, and verify changes — autonomously. Built in Rust for speed.
Get Started
Rust
572
99
暂无描述
Dockerfile
710
4.51 K
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
958
955
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.61 K
942
Ascend Extension for PyTorch
Python
572
694
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
413
339
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
1.43 K
116
暂无简介
Dart
952
235
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
12
2
