技术英语 / 知识点
代码命名英语词汇速查
数据获取与存取
表示取得已有数据或对象,常用于函数名;通常强调读取结果而非创建或计算,适合 getUser、getConfig 等直接获取场景。
get
在命名中看到 get 时,通常把它理解为“取得已经存在或可以直接访问的数据”。当函数主要负责读取对象、属性、配置或已知资源,而不是搜索候选项、加载外部内容或创建新值时,可优先考虑 get。
边界
get 强调调用者想要的是某个数据结果,但它本身不严格规定数据来自内存、缓存还是其他读取层。因此命名时还应结合项目约定判断调用成本和失败方式,不能仅凭 get 推断一定是零开销的字段访问。
如果操作的核心是从多个候选对象中按条件定位一个目标,find 通常更准确;如果重点是从文件、网络或远端服务把内容载入当前上下文,load 或 fetch 往往能表达更多信息;如果结果需要复杂推导,使用 calculate、compute 等词更能体现行为。
与相邻词的区别
| 词 | 核心含义 | 典型命名 |
|---|---|---|
get |
取得已有或可直接读取的数据 | getUser、getConfig |
find |
从候选范围中按条件寻找目标 | findUserByEmail |
fetch |
主动取得远端或外部数据,常暗示 I/O | fetchUserProfile |
load |
把外部内容载入内存或当前上下文 | loadConfig |
关键区别不在返回值是不是对象,而在函数的主要动作是什么。
最小例子
下面的 getUserName 只是从已知对象中取得已有属性,没有搜索候选集合,也没有创建新数据。
const user = { id: 42, name: "Ada" };
function getUserName(user) {
return user.name;
}
console.log(getUserName(user));预期输出
Ada常见误解
不要把所有“返回数据”的函数都命名为 get。例如按邮箱遍历用户列表寻找匹配项,行为重点是“查找”,使用 findUserByEmail 比 getUserByEmail 更能表达实现语义;需要发起网络请求时,如果团队约定用 fetch 区分 I/O,也不应为了统一前缀而全部改成 get。
表示根据条件寻找目标,常用于集合、数据库或索引查询;重点是从候选范围中定位某个对象,不强调单纯读取字段。
find
在命名中看到 find 时,通常表示“根据条件从一组候选对象中寻找匹配项”。当函数需要检查集合、索引或查询结果并定位目标,而不是直接读取一个已知值时,find 能更准确地表达意图。
边界
find 的关键前提是存在候选范围和匹配条件。候选范围可以是数组、集合、数据库记录或搜索索引;实现可以是线性遍历,也可以利用索引,但调用语义仍然是“寻找符合条件的对象”。
find 不承诺一定找到结果,因此返回 null、undefined、空结果或语言规定的可选类型都可能合理,具体失败语义应由接口契约决定。若调用逻辑要求目标必然存在,团队也可能使用 require、getOrThrow 等更强语义的名称。
与相邻词的区别
| 词 | 回答的问题 | 更适合的场景 |
|---|---|---|
find |
哪个候选对象满足条件 | 按 ID、邮箱或谓词寻找对象 |
get |
已知目标的数据是什么 | 读取属性、配置或已知资源 |
search |
哪些候选结果与查询相关 | 全文搜索、多结果检索 |
filter |
哪些元素全部满足条件 | 返回多个匹配元素 |
find 通常倾向于定位一个目标;如果预期返回一组匹配结果,filter、search 或项目约定的复数命名往往更清楚。
最小例子
下面的函数必须遍历候选用户,并根据 id 条件定位匹配对象,因此使用 find 比 get 更贴合行为。
const users = [
{ id: 1, name: "Ada" },
{ id: 2, name: "Linus" }
];
function findUserById(users, id) {
return users.find((user) => user.id === id);
}
console.log(findUserById(users, 2));预期输出
{ id: 2, name: 'Linus' }常见误解
不要因为函数接收查询条件就自动使用 find。如果键已经唯一且函数只是直接读取映射中的值,getUserById 也可能更符合团队语义;反过来,若函数需要在候选范围内执行匹配,使用 find 能提醒调用者“目标可能不存在”,也能与单纯读取操作区分开。
表示从文件、流、缓存或设备中读取内容,突出输入动作本身;适合 readFile、readBuffer 等底层或 I/O 语境。
read
read 表示从已有数据源取出内容,重点是读取动作本身。命名文件、流、缓冲区、设备或其他 I/O 操作时,如果调用者关心的是“从这里读出数据”,通常优先考虑 read。
边界
read 通常暗示数据源已经存在,并且当前操作直接消费它的内容。它不必意味着网络访问,也不天然表示把资源初始化到可长期使用的状态。
常见命名包括 readFile、readBuffer、readLine、readBytes。这些名称都明确回答“从什么对象读取什么内容”。
如果方法内部虽然读取了文件,但真正对外表达的是“准备配置供后续使用”,loadConfig 往往比 readConfig 更准确;底层实现动作不应盖过方法对调用者暴露的语义。
与相邻词的区别
| 词 | 主要强调 | 更典型的语境 |
|---|---|---|
read |
从数据源取出内容 | 文件、流、缓冲区、设备、I/O |
load |
把资源带入可使用状态 | 配置、模型、资源、初始化 |
get |
获得一个值或对象 | 属性、状态、轻量访问 |
fetch |
从外部或远端取得数据 | HTTP、远程服务、异步数据获取 |
判断时先看调用者需要理解什么:若关键事实是“正在消费输入”,用 read;若关键事实是“资源经过这个动作后可以被系统使用”,更接近 load。
最小例子
readFile(path) 表示从给定文件中读取内容;readLine() 表示从当前输入流中读取一行。名称都把数据源或读取单位直接暴露给调用者。
相反,把“启动时读取模型文件并完成解析、构建对象和初始化”命名为 readModel() 容易显得过窄,因为最终语义已经超过单纯读取,此时 loadModel() 更清楚。
常见误解是只要函数最终返回数据就使用 read。如果没有明确的输入源或 I/O 含义,get、find、fetch 或其他更具体的动词通常更能表达真实职责。
表示把数据或资源载入内存、运行环境或当前上下文,强调从外部来源进入可使用状态,适合配置、模型和资源文件场景。
load
load 表示把外部数据或资源带入当前运行环境,使其进入可使用状态。配置、模型、资源文件、插件或缓存内容需要读取并完成解析、初始化或注册时,常用 load 表达这一整体动作。
边界
load 强调的是状态转换:调用前资源尚未进入当前上下文,调用后它已经被准备好供后续逻辑使用。具体实现可能包含文件读取、网络访问、反序列化、校验或对象构建,但这些步骤不必全部体现在方法名中。
常见命名包括 loadConfig、loadModel、loadResources。如果操作只是从流中读取若干字节,却没有“载入并准备”的含义,使用 read 通常更精确。
load 也不等同于“第一次初始化”。一个资源可以被重复加载、重新加载或按需加载,因此是否只执行一次应由生命周期设计或其他命名表达。
与相邻词的区别
| 词 | 主要强调 | 更典型的语境 |
|---|---|---|
load |
资源进入可使用状态 | 配置、模型、资源、插件初始化 |
read |
从数据源读取内容 | 文件、流、设备、缓冲区 |
fetch |
从外部来源取得数据 | 网络请求、远程数据源 |
init |
建立对象或组件的初始状态 | 初始化内部状态、依赖或生命周期 |
fetchModel() 更容易让人理解为“把模型数据从远端取回来”;loadModel() 则更强调“模型最终已经进入当前进程并可供推理或计算使用”。两者可以出现在同一流程的不同层级。
最小例子
loadConfig() 可以表示读取配置文件、解析内容并生成程序可直接查询的配置对象;loadTexture() 可以表示把纹理资源读入内存并完成运行时所需的准备。
如果一个方法只是返回已经存在于内存中的配置对象,仍命名为 loadConfig() 会误导调用者,以为存在加载成本或状态变化,此时 getConfig() 往往更符合语义。
常见误解是把所有文件读取都命名为 load。只有当读取动作服务于“把资源准备到当前上下文”这一更高层目的时,load 才比 read 更准确。
表示把当前状态或对象持久化到文件、数据库等目标,重点是保存已有内容;与 persist 相比更通用、更偏业务层命名。
保存:save
save 表示把当前对象、状态或用户正在编辑的内容保存到可再次读取的位置;当命名重点是“把这份内容留下来”,而不是强调底层写入机制时优先考虑它。
边界
save 通常出现在业务层或应用层命名中,例如保存草稿、保存用户设置、保存订单修改。目标可以是数据库、文件或其他持久化介质,但名称本身不需要暴露具体存储方式。
它强调的是保存这一业务意图,而不严格规定内部执行的是新增、更新还是覆盖。因此一个 saveUser 实现可能根据对象状态执行插入或更新,这并不与名称冲突。
如果方法只是把一段字节输出到流、缓冲区或设备,write 往往更准确;如果需要明确表达对象进入持久化状态,并且代码位于 ORM、Repository 或基础设施层,persist 可能更专业。
与相邻词的区别
| 词 | 命名重点 | 常见位置 |
|---|---|---|
save |
保存当前内容或状态 | 业务层、应用层、编辑流程 |
persist |
使对象进入持久化存储 | ORM、Repository、持久化基础设施 |
write |
向文件、流、设备等执行写操作 | I/O、文件系统、网络或设备接口 |
store |
把数据放入某个存储位置 | 缓存、对象存储、键值存储等 |
例如“保存用户正在编辑的草稿”使用 saveDraft 很自然;若函数职责只是把序列化结果写进文件句柄,则 writeFile 或 writeBuffer 更能暴露真实动作。
最小例子
saveSettings 表示保存当前设置,调用方不需要知道最终写入数据库还是配置文件。persistEntity 则更像持久化层术语,重点是让实体被持久化管理或落入存储。
常见误解是把所有数据库写操作都命名为 save。如果职责其实是明确的 insert、update、write 或批量写入,使用更具体的动词通常能减少调用者对副作用和执行语义的猜测。
表示将数据写入文件、流、套接字或设备,强调输出动作;适合 writeFile、writeBuffer 等底层 API 或资源操作名称。
写入:write
write 表示把数据输出到文件、流、套接字、缓冲区或设备等目标;当命名需要突出实际的 I/O 写动作,而不是“保存某个业务对象”时使用它。
边界
write 描述的是数据从当前代码流向某个可写目标的动作,通常位于文件系统、网络、序列化、驱动或其他基础设施代码中。它不天然表示数据会被长期保存,也不保证调用完成后数据已经真正落盘。
例如向内存缓冲区写入数据同样可以叫 writeBuffer;向套接字发送字节也可能使用 write。因此判断标准不是“是否进入数据库”,而是接口是否把调用者提供的数据写向某个输出目标。
如果调用方关心的是保存草稿、保存设置等业务结果,save 更自然;如果动作本质是网络消息发送,并且目标不是抽象的可写流,send 往往比 write 更能表达意图。
与相邻词的区别
| 词 | 命名重点 | 典型对象 |
|---|---|---|
write |
执行输出或 I/O 写入 | 文件、流、缓冲区、套接字、设备 |
save |
保存当前业务内容或状态 | 草稿、配置、实体、文档 |
send |
把消息或数据发送给另一端 | 请求、消息、数据包、邮件 |
append |
在已有内容末尾追加 | 日志、文件、列表式存储 |
当接口接收字节并写入文件时,writeFile 能直接说明动作和目标;若功能是让用户点击“保存文档”,即使底层最终执行文件写入,对外业务方法仍更适合叫 saveDocument。
最小例子
writeBuffer 表示把数据写入缓冲区,重点是输出动作;saveProfile 表示保存用户资料,重点是业务状态被保留下来。两者内部都可能发生数据复制或持久化,但抽象层级不同。
常见误解是把 write 当成“永久保存”的同义词。缓冲写、异步写和套接字写都可能只表示数据已交给下一层;是否真正持久化、刷新到磁盘或被远端接收,需要由具体 API 契约决定。
创建与修改
表示从无到有建立对象、记录或资源,通常暗含新的身份或实体产生;适合 createUser、createOrder 等构造型业务操作。
create:创建新实体
create 表示从无到有产生一个新的对象、记录或资源,通常意味着结果拥有新的身份;看到 createUser、createOrder 这类命名时,可以预期调用后会出现此前不存在的实体。
边界
create 强调的是新实体产生,而不是对象内部经过多少计算步骤。即使实现只执行一次简单插入,只要语义是产生新的业务实体,仍适合使用 create。
如果操作只是修改已有实体,不宜命名为 create;例如更新已有用户邮箱,更接近 updateUserEmail。如果重点是把多个输入逐步组装成结果,则通常更接近 build。
与相邻动词的区别
| 动词 | 核心含义 | 典型命名 |
|---|---|---|
create |
产生新的实体或资源 | createUser、createOrder |
build |
根据多个组成部分构造结果 | buildQuery、buildImage |
update |
修改已经存在的实体 | updateUser、updateOrder |
判断时先问:调用前这个实体是否不存在,调用后是否新产生了一个具有独立身份的实体? 如果答案是肯定的,create 通常最准确。
最小例子
下面的示例中,每次 createUser 都产生一个带新 id 的用户对象,因此名称中的 create 与行为一致。
let nextId = 1;
function createUser(name) {
return { id: nextId++, name };
}
const user = createUser("Ada");
console.log(user);预期输出
{ id: 1, name: 'Ada' }这里如果函数只是接收一个已有用户并改变其 name,继续命名为 createUser 就会误导调用者。
常见误解
不要把所有“返回一个对象”的函数都命名为 create。例如从缓存读取用户仍然是读取行为,即使最终返回了一个对象,也更适合 getUser 或 loadUser;判断依据是业务语义上是否产生了新的实体,而不是返回值类型。
表示根据多个输入逐步组装出结果,常用于复杂对象、查询、镜像或可执行产物;比 create 更强调过程与组成关系。
build:组装结果
build 表示依据多个输入、规则或中间步骤组装出一个结果,重点在构造过程和组成关系;看到 buildQuery、buildConfig 或 buildImage 时,可以预期结果由已有材料加工组合而成。
边界
build 不要求结果一定拥有新的业务身份。它可以构造查询字符串、配置对象、语法树、镜像或可执行产物,这些结果的共同点是由若干输入按照规则组合得到。
如果重点只是“创建一个新的业务实体”,而组装过程并不重要,通常 create 更自然。例如新增订单可命名为 createOrder;根据筛选条件拼接查询语句则更适合 buildQuery。
与 create 的区别
| 动词 | 关注点 | 常见结果 |
|---|---|---|
build |
如何由多个部分组合成结果 | 查询、配置、复杂对象、构建产物 |
create |
新实体从无到有产生 | 用户、订单、资源记录 |
两者可能同时适用于某些实现,此时应依据调用者最需要理解的语义选择:强调新实体身份用 create,强调组装过程用 build。
最小例子
下面的 buildQuery 根据多个查询条件组合出最终字符串,没有创建新的业务实体,因此 build 比 create 更贴切。
function buildQuery(status, limit) {
const params = new URLSearchParams({ status, limit: String(limit) });
return `/orders?${params.toString()}`;
}
console.log(buildQuery("paid", 20));预期输出
/orders?status=paid&limit=20这里函数的核心行为是把路径和参数组装成查询字符串,而不是向系统中新建一个订单或其他资源。
常见误解
不要因为项目里存在“构建步骤”就把所有产出函数都命名为 build。例如真正向数据库插入新用户的函数仍更适合 createUser。同时,构建工具中的 build 常特指编译、打包等产物生成流程;给业务函数命名时仍应根据该函数自身的组装语义判断。
表示修改已有对象或记录的部分或全部信息,通常保留原身份;适合 updateUser、updateStatus 等业务与持久化层命名。
update
update 表示在保留对象或记录身份的前提下,修改其部分或全部已有信息,常用于业务对象、数据库记录或缓存条目的更新操作。
边界
update 的重点是已有对象被写入新信息,通常隐含目标已经存在。它不要求每个字段都变化,也不表示删除旧对象后重新创建一个新对象。
命名为 updateUser、updateStatus 时,调用者通常可以预期操作目标是已存在的用户或状态记录;如果函数实际只计算新值而不写回对象,update 往往会让副作用显得比实际更强。
与 change 的区别
| 词 | 主要强调 | 常见命名意图 |
|---|---|---|
update |
对已有对象或记录执行更新 | updateUser、updateProfile |
change |
值、状态或特征发生变化 | changePassword、changeTheme |
update 更容易让人联想到一次明确的写操作;change 更关注从旧状态到新状态的变化,不一定对应通用的持久化更新接口。
最小例子
updateUser(userId, profile) 表达“找到已有用户并更新资料”,即使只修改昵称字段,也仍然符合 update 的语义。
相反,如果函数只是返回调整后的配置但不保存,例如根据输入计算一个新对象,使用 updateConfig 可能让调用者误以为原配置已经被写回。
常见误解是认为 update 必须修改对象的全部字段。实际上,全量替换还是部分更新应由具体 API 契约说明,update 本身只表达已有对象被更新。
强调某个值、状态或特征发生变化,语义比 update 更宽;适合表达变化本身,不适合所有持久化更新操作的统一命名。
change
change 表示某个值、状态、属性或行为模式从一种状态变为另一种状态,重点是变化本身,而不是具体采用哪种存储或更新机制。
边界
change 的语义比 update 更宽。它可以对应内存中的状态切换、用户主动修改某项设置,也可以最终触发持久化,但单凭名称不能推出一定存在数据库写入。
因此,changePassword、changeTheme、changeState 适合表达一个清晰的状态转换;如果函数职责是通用地写回某个实体的多项字段,通常使用 update 更准确。
与 update 的区别
| 词 | 关注点 | 对持久化写入的暗示 |
|---|---|---|
change |
从旧值或旧状态变到新值或新状态 | 不一定存在 |
update |
对已有对象或记录写入新信息 | 通常更强 |
例如,changeTheme("dark") 主要告诉读者主题发生切换;updateUser(userId, data) 则更像对已有用户记录执行一次更新。
最小例子
函数名 changeStatus(order, "paid") 强调订单状态从当前值切换到 paid。这个函数可以只修改内存对象,也可以继续保存到数据库,具体副作用需要由接口契约说明。
如果把所有数据库更新方法统一命名为 changeUser、changeOrder,调用者很难判断是修改单个状态、替换某个值,还是执行完整记录更新。
常见误解是把 change 当成 update 的直接同义词。两者可以在部分场景互换,但命名时应先判断要表达的是“状态变化”还是“对已有对象执行更新”。
表示给属性、配置或上下文赋予指定值,通常对应直接赋值动作;适合 setName、setTimeout 等 setter 或配置接口。
设置:set
set 表示把一个明确的值写入某个属性、配置项或上下文位置,重点是“指定为这个值”,而不是创建对象、计算结果或保证整组变更立即生效。
边界
set 最适合目标和值都清楚的赋值动作,例如设置名称、超时时间、状态或选项。方法调用之后可能只是修改内存字段,也可能委托给底层配置系统;仅凭 set 这个词不能推断是否持久化、是否触发网络请求或是否立即生效。
如果方法的核心语义是基于旧值增减、合并集合、应用补丁或提交一批修改,应优先使用能表达这些动作的词,而不是笼统使用 set。
与相邻词的区别
| 词 | 核心语义 | 典型命名 |
|---|---|---|
set |
把目标指定为某个值 | setName、setTimeout |
update |
修改已有数据,常允许只变更部分字段 | updateProfile |
apply |
把规则、补丁或配置作用到目标,使变更进入执行或生效阶段 | applyPatch |
assign |
强调分配关系、职责或引用 | assignOwner |
判断重点是动作本身:若调用者已经持有一个值,只需要把目标改成该值,set 通常最直接。
最小例子
下面的例子只用于展示命名边界:setName 直接替换名称,没有合并或增量更新语义。
class User {
constructor() {
this.name = "";
}
setName(name) {
this.name = name;
}
}
const user = new User();
user.setName("Ada");
console.log(user.name);预期输出
Ada如果方法需要根据旧名称计算新名称,或者同时修改多个用户字段,单纯的 setName 就可能无法准确表达真实行为。
常见误解
常见误解是看到“修改数据”就统一使用 set。set 强调的是指定值,不等同于所有修改操作;批量更新、增量调整、合并和应用规则分别可能更适合 update、increment、merge 或 apply。
表示把规则、配置、补丁或变更真正作用到目标对象,强调让某项修改生效;适合 applyPatch、applyConfig 等场景。
应用修改:apply
apply 表示把已经存在的规则、配置、补丁或变更作用到某个目标上,重点不是“产生这份变更”,而是让它参与目标的实际处理或状态变化。
边界
使用 apply 时,通常已经有一个可应用的输入,例如配置对象、补丁、样式、过滤规则或迁移步骤。方法负责把这份输入作用到目标,而不是仅保存一个字段值。
apply 本身不保证结果一定永久持久化,也不必然意味着立即写入数据库。具体是修改内存对象、刷新运行时状态还是提交到底层系统,要由接口契约决定。
与相邻词的区别
| 词 | 核心语义 | 典型命名 |
|---|---|---|
apply |
把已有规则或变更作用到目标 | applyPatch、applyConfig |
set |
把某个位置直接指定为一个值 | setTimeout |
update |
修改已有实体或记录的数据 | updateUser |
commit |
确认并提交一组已经准备好的变更 | commitChanges |
如果动作只是把 timeout 从一个值改成另一个值,setTimeout 更直接;如果传入的是一整套配置,并由方法逐项作用到运行对象,applyConfig 更能表达过程。
最小例子
下面用 applyConfig 把一组已有配置作用到服务器对象,体现“应用整组变更”而非单字段赋值。
class Server {
constructor() {
this.port = 80;
this.debug = false;
}
applyConfig(config) {
Object.assign(this, config);
}
}
const server = new Server();
server.applyConfig({ port: 8080, debug: true });
console.log(server.port, server.debug);预期输出
8080 true这里的重点是 config 作为一个完整输入被作用到目标;若接口只接收单个端口值,使用 setPort 通常更清晰。
常见误解
常见误解是把 apply 当成 set 的更正式写法。两者关注点不同:set 强调“指定一个值”,apply 强调“让一份规则或变更作用于目标”。命名时应依据真实动作,而不是为了显得抽象而替换动词。
处理与控制
表示针对输入、事件、请求或异常执行处理逻辑,强调响应某个触发源;常见于 handler、handleEvent、handleError 等命名。
handle
handle 表示接到某个输入或触发后负责处理它,适合事件、请求、消息、异常等具有明确触发源的代码;看到这个词时,可以预期函数承担的是响应与处置职责。
边界
handle 强调“这个输入由谁接住并处理”,但不限定内部只有一步,也不说明一定完成完整业务流程。handleEvent 可以只做分发,handleError 可以记录、转换或恢复,具体动作仍需结合后续名词判断。
如果函数只是读取、查询或转换数据,而没有“响应某个输入”的语义,通常不应仅因为函数内部做了若干操作就命名为 handle。
与 process 的区别
| 词 | 主要强调 | 常见命名 |
|---|---|---|
handle |
响应某个事件、请求、异常或输入 | handleEvent、handleRequest、handleError |
process |
对数据或任务执行一组处理步骤 | processOrder、processJob、processBatch |
例如,请求刚进入控制器时可以由 handleRequest 接住;随后执行校验、计算、持久化等连续步骤时,更可能调用 processRequest 或更具体的业务函数。
最小例子
handleClick 表达“点击发生后,由这个函数负责响应”;handleError 表达“错误出现后,由这个函数负责处置”。这里的共同点是都存在一个先发生的触发源。
常见误解是把 handle 当成泛化的“做事情”。如果名字里看不出它在响应什么,应优先补充对象,例如用 handleMessage,而不是只写含义模糊的 handle。
表示对输入进行一组业务或计算步骤,强调处理过程本身;适合 processRequest、processJob 等具有明确处理链的场景。
process
process 表示让一个输入、任务或数据经过一组处理步骤并产生处理结果,适合存在明确处理链的业务、作业或批量数据;看到这个词时,可以预期函数关注的是处理过程本身。
边界
process 通常暗示不止一次简单读取或赋值,而是包含校验、转换、计算、调用下游或状态更新等一个或多个阶段。不过它并不保证一定完成整个端到端业务流程,范围仍由对象决定,例如 processItem 与 processOrder 的职责大小可以完全不同。
只有一个明确原子动作时,更具体的动词通常更清楚,例如 validateOrder、saveOrder、calculateTotal,而不是统一写成 processOrder。
与 handle 的区别
| 词 | 主要强调 | 判断重点 |
|---|---|---|
process |
输入经历哪些处理步骤 | 处理链和结果 |
handle |
谁响应并处置某个触发 | 事件、请求或异常的接收与响应 |
handleRequest 更像请求入口的职责描述;processRequest 更强调请求进入后执行校验、转换、业务计算等处理链。两者可以出现在同一调用路径中,并不互斥。
最小例子
processJob 可以表示取出一个任务后依次校验参数、执行计算并记录结果;如果函数实际上只检查任务是否合法,命名为 validateJob 会比 processJob 更精确。
常见误解是把任何“处理数据”的函数都命名为 process。当函数职责可以用更具体的动作准确表达时,应优先使用具体动词,避免 process 掩盖真实行为。
表示执行已经确定的一项命令、计划或操作,强调动作被真正运行;适合 executeQuery、executeTask 等执行器或服务命名。
execute
execute 表示把已经确定的命令、查询、任务或操作真正交给执行机制运行,命名重点是“开始并完成执行”,而不是准备、选择或构造要做的事情。
边界
适合对象已经明确、当前方法负责触发实际执行的场景,例如 executeQuery、executeTask、executeCommand。如果方法只是创建执行计划、验证参数、把任务加入队列或选择处理器,通常不应仅因为后续会运行就命名为 execute。
execute 也不保证调用一定成功。名称表达的是方法承担执行职责;失败、异常、取消或返回业务错误仍可能发生。
与相邻动词的区别
| 动词 | 命名重点 | 典型语境 |
|---|---|---|
execute |
执行已经确定的操作 | 查询、命令、任务、计划 |
run |
让程序、任务或流程运行 | 作业、测试、进程、工作流 |
perform |
完成某项较抽象的动作或职责 | 检查、计算、业务动作 |
invoke |
显式调用某个可调用目标 | 方法、回调、反射、代理 |
当名称需要突出“执行一个命令对象”时,executeCommand 通常比 runCommand 更强调执行器职责;当对象本身就是可运行任务时,runTask 也可能更自然,需服从项目既有词汇体系。
最小例子
executeQuery(query)
executeTask(task)这里调用者已经持有明确的查询或任务,方法负责把它实际执行。相反,buildQuery() 只构造查询,scheduleTask() 只安排任务,都不属于 execute 的核心语义。
常见误解是把任何“做事情”的方法都命名为 execute。如果方法真正表达的是创建、调度、调用或处理,应使用能体现具体职责的动词,避免让调用者误以为副作用会立即发生。
表示显式调用函数、方法、回调或操作,语气比 call 更正式;适合框架、反射、代理和抽象调用层的技术命名。
invoke
invoke 表示显式触发某个函数、方法、回调或抽象操作的调用,强调“调用一个可调用目标”这一技术动作,常见于框架、反射、代理和回调分发层。
边界
适合调用目标已经存在,而当前方法负责通过直接或间接机制触发它的场景,例如 invokeCallback、invokeHandler、invokeMethod。它不要求调用目标必须以普通函数形式存在,也可以经过反射、代理、适配器或框架分发。
如果方法主要负责完成完整业务流程,而调用其他函数只是内部实现细节,通常不应仅因此使用 invoke。业务层名称应优先描述业务动作本身。
与相邻动词的区别
| 动词 | 命名重点 | 典型语境 |
|---|---|---|
invoke |
技术性地触发可调用目标 | 反射、代理、回调、处理器 |
call |
一般意义上的调用 | 普通函数或服务调用 |
execute |
执行一个已经确定的操作 | 命令、查询、任务 |
dispatch |
根据规则把请求分派给目标 | 事件、消息、请求、处理器 |
invoke 往往比 call 更正式,也更容易暗示存在抽象调用层。例如代理对象可以 invoke 目标方法,而普通业务代码中的直接函数调用未必需要使用这个词。
最小例子
invokeCallback(callback)
invokeMethod(target, method)第一个名称强调触发回调,第二个强调通过抽象机制调用目标方法。若方法真正负责的是选择哪个处理器,应考虑 dispatch;若目标已经选定,只负责触发它,invoke 更准确。
常见误解是认为 invoke 只是 call 的高级同义词。命名时应关注抽象层次:普通业务调用使用 call 或具体业务动词通常更直接,只有需要突出“触发一个可调用目标”的机制语义时才优先使用 invoke。
表示主动引发事件、流程或动作,强调起因而非处理结果;适合 triggerRefresh、triggerEvent 等事件驱动场景。
trigger:触发
trigger 表示主动引发一个事件、流程或动作,使后续处理开始执行;命名重点是“让某件事发生”,而不是描述后续具体如何处理。
边界
适合调用方只负责发起行为,而真正的处理由其他函数、事件监听器或流程完成的场景。例如 triggerRefresh 表示发起刷新动作,但不承诺当前函数本身完成数据获取、界面更新等全部步骤。
如果函数直接执行并完成业务动作,应优先使用能描述具体行为的动词,如 refresh、send、save,而不是为了显得通用统一使用 trigger。
与相近词的区别
| 词 | 关注点 | 典型命名 |
|---|---|---|
trigger |
主动引发事件或流程 | triggerRefresh |
emit |
向外发布一个事件或信号 | emitChange |
handle |
接收并处理已经发生的事件 | handleRefresh |
execute |
实际执行一段任务或命令 | executeJob |
trigger 与 handle 最容易混淆:前者处在因果链的发起端,后者处在响应端。
最小例子
用户点击“重新加载”按钮时,按钮逻辑可以调用 triggerRefresh() 发起刷新;随后 handleRefresh() 接收该事件并执行刷新处理。两个名称分别说明“谁发起”和“谁处理”。
常见误解是把所有“调用一个函数”的行为都命名为 triggerXxx。只有当“触发”本身就是该函数的主要职责,且具体工作由后续流程承担时,这个词才准确。
表示在某个动作发生前阻止它继续,强调预防和拦截;适合 preventDefault、preventDuplicate 等守护或校验逻辑。
prevent:阻止
prevent 表示在某个动作或不期望结果真正发生之前进行拦截,使其不再继续;命名重点是“预防发生”,而不是发生之后再处理或修复。
边界
适合守卫、校验、去重和默认行为拦截等前置逻辑,例如 preventDuplicate 表示避免重复操作产生,而不是在重复数据已经写入后再清理。
如果动作已经发生,随后执行撤销、删除或恢复,应使用更能表达结果的词,如 rollback、remove、restore,而不是 prevent。
与相近词的区别
| 词 | 关注点 | 典型语义 |
|---|---|---|
prevent |
在发生前阻止 | 防止重复提交 |
block |
明确拒绝通过或访问 | 阻断请求、用户或资源 |
cancel |
终止已经计划或开始的操作 | 取消任务 |
disable |
让能力处于不可用状态 | 禁用按钮或功能 |
prevent 强调预防某个具体结果;disable 更偏向持续状态,cancel 则通常意味着目标操作已经存在。
最小例子
表单即将提交时,preventDuplicate() 可以先检查同一请求是否正在处理中,并阻止第二次提交。它描述的是重复操作产生之前的保护,而不是提交完成后的补救。
常见误解是把“返回失败”都理解为 prevent。只有逻辑确实位于目标动作之前,并以阻止其继续为职责时,使用 prevent 才能准确表达代码意图。
校验与结果
表示检查输入是否满足业务或结构规则,通常不负责自动修正;适合 validateInput、validateOrder 等校验型函数命名。
validate
validate 表示把输入与一组明确规则进行校验,判断其是否满足结构、格式或业务约束;看到这个词时,应预期函数负责发现违规,而不是自动修正数据。
边界
validate 最适合存在明确规则集合的场景,例如必填字段、取值范围、对象结构或业务约束。它描述的是规则校验职责,并不规定失败时必须返回布尔值、错误列表还是抛出异常,具体契约仍需查看函数签名或项目约定。
命名为 validateInput、validateOrder 时,通常意味着调用者提交一个待校验对象,函数据既定规则判断是否合法。若函数主要负责补默认值、规范化格式或纠正输入,normalize、sanitize、fix 等词通常更能表达实际职责。
与 check 的区别
| 词 | 更强调什么 | 典型命名 |
|---|---|---|
validate |
是否符合一组明确规则 | validateInput、validateOrder |
check |
一般性的条件、状态或存在性检查 | checkReady、checkPermission |
两者都可能最终得到真假结果,但 validate 通常暗示存在可说明的有效性规则;check 的语义更宽,并不必然表示完整校验。
最小例子
下面的函数只判断年龄是否满足“非负整数”规则,没有修改输入:
function validateAge(age) {
return Number.isInteger(age) && age >= 0;
}
console.log(validateAge(18));
console.log(validateAge(-1));预期输出:
true
false这里使用 validateAge 比 checkAge 更明确,因为函数是在依据具体有效性规则判断输入是否合法。
常见误解是认为名称中出现 validate 就一定会抛异常,或者一定会返回 boolean。validate 只说明校验职责,返回方式必须由该 API 的实际契约决定。
表示进行一般性的条件、存在性或状态检查,语义比 validate 更宽;适合 checkPermission、checkReady 等快速判断场景。
check
check 表示执行一般性的条件、存在性或状态检查;看到这个词时,可以预期函数会确认某个条件是否成立,但不能仅凭名称推断它执行了完整的规则校验。
边界
check 的覆盖范围很宽,可以用于权限是否具备、资源是否存在、组件是否就绪或某个前置条件是否满足。它适合命名 checkPermission、checkReady 这类快速判断函数。
如果函数需要依据一组明确规则判断输入是否合法,validate 通常更精确;如果函数实际等待状态变化、修改对象或执行修复,单独使用 check 容易掩盖副作用,应改用能表达动作的名称。
与 validate 的区别
| 词 | 语义范围 | 更典型的问题 |
|---|---|---|
check |
较宽,可检查任意条件或状态 | “现在是否就绪?” |
validate |
较窄,强调符合明确规则 | “这个输入是否合法?” |
因此 checkReady 很自然,因为它只检查当前状态;validateOrder 更自然,因为订单通常需要满足一组结构或业务规则。
最小例子
下面的函数只检查当前状态是否为 ready:
function checkReady(state) {
return state === "ready";
}
console.log(checkReady("ready"));
console.log(checkReady("loading"));预期输出:
true
false这里没有复杂的有效性规则,只回答一个状态条件是否成立,因此 checkReady 比 validateReady 更符合语义。
常见误解是把所有返回布尔值的函数都命名为 check...。返回类型不能决定动词;若真正职责是验证输入规则、查找对象或判断能力,仍应优先选择能准确表达该职责的词。