单词拼写
前端开发常见用词规范
介绍
良好的命名约束有助于快速理解文件结构，比如看到fetch就知道这里是做了某个请求，与后端进行交互；看到on就知道这个是用于监测事件。以下整理了常见的命名合集，供参考。
使用
以下提供了若干单词，通常作为某一方法或属性的前缀，格式如on+click=onClick。
🏝️ 常见名词
无固定约束，大多数通常场景的名称，如查询用户信息可以使用query+userInfo=queryUserInfo 。
get
获取
通用的获取方法命名
set
设置
常用于设置属性的类方法命名，也可作为通用设置方法命名
delete
删除
表示删除，和Remove相似
query
查询
根据某一特征进行查询
reset
重置
重置状态，数据，配置等
insert
插入
任意位置插入
append
追加
在尾部添加
calculate
计算
通过的计算获取内容
🏝️ 调用接口
与后端进行接口对接时使用的命名，如获取订单数据fetch+orders=fetchOrders。
push
增加(推)
存入,推送(通知)
remove
移除
表示移除,和Delete相近
update
更新
更新(多用于配置，状态等)
find
查找
查询
fetch
获取
通过网络请求获取内容
DTO
数据传输格式
Data Transfer Object
🏝️ 状态变化
表示某一种状态，如显示，隐藏，暂停等，通常加上is用布尔值来表示，如isStart。
start
开始
开始(强调开始某个流程)
pending
加载中
加载中
pause
暂停
暂停(强调流程的暂停，有可能后续会继续开启)
keep alive
保持
保持某种状态
refresh
刷新
用于命名刷新(多用于页面,缓存等)
stop
中止
停止(强调流程的终止)
finish
完成
完成(强调流程的完成)
close
关闭
关闭(多用于关闭状态,关闭文件等)
destroy
销毁
销毁实例，常用语析构方法
🏝️ 实例操作
实例专用，如虚拟dom，vue实例等实例，如create+element=createElement。
create
创建
创建实例，常用于实例化方法和工厂方法的命名
destroy
销毁
销毁实例，常用语析构方法
generate(gen)
生成
生成实例，通常传参生成的方式
initialize(init)
初始化
初始化实例的属性和设置，Initialize本身也可作为类方法用来初始化
wrap
包裹
额外添加上某个特性
uninitialize(uninit)
卸载初始化
清理实例的属性和设置，通常和Initialize对应
load
加载
加载配置，根据配置创建内容
🏝️ 方法操作
作为方法单独存在的名称，通常用作函数命名，如open+dialog=openDialog。
read
读取
读取(多用于文件，配置等)
receive
接收
接收(多用于文件，消息等)
pull
拉取
拉取
write
写入
写入(文件/配置等)
put
放入
放入
open
打开
开启(多用于开启状态,打开文件等)
launch
启动
发动/启动(多用于启动程序,服务)
filter
筛选
过滤,筛选(强调按照某些条件)
merge
合并
合并(有时会带上合并规则)
concat
拼接
拼接(直接在结尾添加)
split
分割
分割
deduplicate
去重
去重(去重完全相同的项)
reverse
倒序
颠倒,反向排列
sort
正序
排序(有时会带上排序规则)
fill
填充
填充(一般会进行覆盖)
parse
解析
解析(解析成某些格式,解析提取某些内容)
analyse
分析
分析(不一定能通过简单的方式获取)
convert
类型转换
类型转换(通常用于从一个类型转换到另一种类型)
format
格式转换
格式化数据
validate
字段校验
合法性/有效性的校验
ensure
期待值校验
期待值的校验
compose
组合
组成(一般由多项内容组成一个结果)
encode
编码
编码(依赖约定的编码格式)
decode
解码
解码(依赖约定的解码格式)
encrypt
加密
数据加密(依赖约定的加密算法)
decrypt
解密
数据解密(依赖约定的解密算法)
backup
备份
备份(需要注意拷贝方式，避免误导)
restore
恢复
恢复
import
导入
导入(通常用于按照特定格式的文件转换)
export
导出
导出(通常用于转换成特定格式的文件)
compress
压缩
压缩(依赖约定的算法)
decompress
解压
解压缩(依赖约定的算法)
match
匹配
匹配是否相等
最后更新于