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 StartedRust0448
源启盛夏_AtomGit暑期开发者成长计划「源启盛夏」暑期校园开发者成长计划旨在激活校园开源力量,通过积分激励、认证扶持、资源倾斜等形式,引导高校组织和开发者完成「入驻 — 建项目 — 做贡献 — 获认证 — 得资源」的完整闭环。无论你是想带领社团入驻平台的组织者,还是希望用代码贡献证明自己的开发者,都能在这里找到属于你的成长路径。Markdown00
jiuwenswarmJiuwenSwarm 是一款基于openJiuwen开发的智能AI Agent,它能够将大语言模型的强大能力,通过你日常使用的各类通讯应用,直接延伸至你的指尖。Python0769
Hy3Hy3 是由腾讯混元团队研发的快慢思考融合的混合专家模型,总参数量 295B,激活参数 21B,MTP 层参数 3.8B。4 月底发布 Hy3 Preview 后,我们在 50 多个业务中获得了广泛的反馈,修复了各种体验问题,进一步提升了后训练的质量和规模。今天,我们发布 Hy3。它展现出显著强于同尺寸并比肩旗舰(参数规模往往是 Hy3 的 2~5 倍)开源模型的智能水平,显著提升了在各类产品和生产力任务中的实用价值。Python00
AscendNPU-IRAscendNPU-IR是基于MLIR(Multi-Level Intermediate Representation)构建的,面向昇腾亲和算子编译时使用的中间表示,提供昇腾完备表达能力,通过编译优化提升昇腾AI处理器计算效率,支持通过生态框架使能昇腾AI处理器与深度调优C++0313
DragonOSDragonOS is an operating system developed from scratch using Rust, with Linux compatibility. It is designed for **Serverless** scenarios. 使用Rust从0自研内核,具有Linux兼容性的操作系统,面向云计算Serverless场景而设计。Rust00
热门内容推荐
最新内容推荐
项目优选
收起
暂无描述
Markdown
827
5.49 K
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
494
518
本项目是CANN提供的神经网络类计算算子库,实现网络在NPU上加速计算。
C++
786
1.58 K
作为 Ascend for PyTorch 社区的核心组件,TorchNPU 是昇腾专为 PyTorch 打造的深度学习适配插件,使 PyTorch 框架能够直接调用昇腾 NPU,为开发者提供昇腾 AI 处理器的超强算力。
Python
803
1.14 K
本项目是CANN提供的transformer类大模型算子库,实现网络在NPU上加速计算。
C++
973
2.29 K
deepin linux kernel
C
32
16
AscendNPU-IR是基于MLIR(Multi-Level Intermediate Representation)构建的,面向昇腾亲和算子编译时使用的中间表示,提供昇腾完备表达能力,通过编译优化提升昇腾AI处理器计算效率,支持通过生态框架使能昇腾AI处理器与深度调优
C++
482
312
JiuwenSwarm 是一款基于openJiuwen开发的智能AI Agent,它能够将大语言模型的强大能力,通过你日常使用的各类通讯应用,直接延伸至你的指尖。
Python
3.02 K
769
CANNBot 是面向 CANN 开发的用于提升开发效率的系列智能体,本仓库为其提供可复用的 Skills 模块。
Markdown
1.26 K
811
CANN 学习中心仓,支持在线互动运行、边学边练,提供教程、示例与优化方案,一站式助力昇腾开发者快速上手。
Jupyter Notebook
648
287
