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 StartedRust0153- DDeepSeek-V4-ProDeepSeek-V4-Pro(总参数 1.6 万亿,激活 49B)面向复杂推理和高级编程任务,在代码竞赛、数学推理、Agent 工作流等场景表现优异,性能接近国际前沿闭源模型。Python00
LongCat-Video-Avatar-1.5最新开源LongCat-Video-Avatar 1.5 版本,这是一款经过升级的开源框架,专注于音频驱动人物视频生成的极致实证优化与生产级就绪能力。该版本在 LongCat-Video 基础模型之上构建,可生成高度稳定的商用级虚拟人视频,支持音频-文本转视频(AT2V)、音频-文本-图像转视频(ATI2V)以及视频续播等原生任务,并能无缝兼容单流与多流音频输入。00
auto-devAutoDev 是一个 AI 驱动的辅助编程插件。AutoDev 支持一键生成测试、代码、提交信息等,还能够与您的需求管理系统(例如Jira、Trello、Github Issue 等)直接对接。 在IDE 中,您只需简单点击,AutoDev 会根据您的需求自动为您生成代码。Kotlin03
Intern-S2-PreviewIntern-S2-Preview,这是一款高效的350亿参数科学多模态基础模型。除了常规的参数与数据规模扩展外,Intern-S2-Preview探索了任务扩展:通过提升科学任务的难度、多样性与覆盖范围,进一步释放模型能力。Python00
skillhubopenJiuwen 生态的 Skill 托管与分发开源方案,支持自建与可选 ClawHub 兼容。Python0112
项目优选
收起
暂无描述
Dockerfile
733
4.75 K
Ascend Extension for PyTorch
Python
649
796
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
434
395
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
1.01 K
1.01 K
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
1.25 K
153
deepin linux kernel
C
30
16
华为昇腾面向大规模分布式训练的多模态大模型套件,支撑多模态生成、多模态理解。
Python
146
237
暂无简介
Dart
986
253
昇腾LLM分布式训练框架
Python
167
200
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.68 K
990
