技术英语 / 知识点

代码命名英语词汇速查

数据获取与存取

表示取得已有数据或对象,常用于函数名;通常强调读取结果而非创建或计算,适合 getUser、getConfig 等直接获取场景。

get

在命名中看到 get 时,通常把它理解为“取得已经存在或可以直接访问的数据”。当函数主要负责读取对象、属性、配置或已知资源,而不是搜索候选项、加载外部内容或创建新值时,可优先考虑 get。

边界

get 强调调用者想要的是某个数据结果,但它本身不严格规定数据来自内存、缓存还是其他读取层。因此命名时还应结合项目约定判断调用成本和失败方式,不能仅凭 get 推断一定是零开销的字段访问。

如果操作的核心是从多个候选对象中按条件定位一个目标,find 通常更准确;如果重点是从文件、网络或远端服务把内容载入当前上下文,load 或 fetch 往往能表达更多信息;如果结果需要复杂推导,使用 calculate、compute 等词更能体现行为。

与相邻词的区别

词 核心含义 典型命名
get 取得已有或可直接读取的数据 getUser、getConfig
find 从候选范围中按条件寻找目标 findUserByEmail
fetch 主动取得远端或外部数据,常暗示 I/O fetchUserProfile
load 把外部内容载入内存或当前上下文 loadConfig

关键区别不在返回值是不是对象,而在函数的主要动作是什么。

最小例子

下面的 getUserName 只是从已知对象中取得已有属性,没有搜索候选集合,也没有创建新数据。

js
const user = { id: 42, name: "Ada" };

function getUserName(user) {
  return user.name;
}

console.log(getUserName(user));

预期输出

text
Ada

常见误解

不要把所有“返回数据”的函数都命名为 get。例如按邮箱遍历用户列表寻找匹配项,行为重点是“查找”,使用 findUserByEmail 比 getUserByEmail 更能表达实现语义;需要发起网络请求时,如果团队约定用 fetch 区分 I/O,也不应为了统一前缀而全部改成 get。

创建与修改

处理与控制

校验与结果

目录与阅读设置

记录一个想法

代码命名英语词汇速查

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通