在写代码的时候,离不开创建类、写函数、写方法、定义变量,因此少不了为此命名。
作为程序员的基本素养,不仅要写出有质量的代码,也要让人看的懂你的代码。遵循用英文单词来规范来命名尤为重要。
一个好的命名不仅能清晰的表达代码在上下文中的意图,也能提升代码质量和减少沟通成本。在协同开发发挥出很好的作用。

好了 ,主角来了...

命名提示插件
TypingCat(打字猫) 是一个Idea 单词命名提示补全插件
兼容性

特性
- 包含1万个常用单词
- 支持应用于代码命名:局部变量、常量、方法名、方法参数、类名
- 支持模糊搜索
- 基于代码补全,使用快捷键 Ctrl + space
- 离线模式,响应更快
- 兼容 Idea、Android Studio 、Pycharm 、Goland
演示

更多
关于TpyingCat插件交流,请移至Github,欢迎star和提出issue
额外干货单词命名规范表():
返回值为boolean类型的方法名前缀
位置 | 单词 | 意味 | 例 |
---|
前缀 | is | (对象)是否处于预期状态 | isChecked |
前缀 | can | (对象)是否可以做你期望的事情 | canRemove |
前缀 | should | (调用者)是否应该执行指令 | shouldMigrate |
前缀 | has | (对象)是否具有预期的数据属性 | hasObservers |
前缀 | needs | (调用者)是否需要执行指令 | needsMigrate |
按需执行时的处理方法
位置 | 单词 | 意味 | 例 |
---|
后缀 | IfNeeded | 需要就做,不需要就什么都不做 | drawIfNeeded |
前缀 | might | 同上 | mightCreate |
前缀 | try | 尝试执行,如果失败则跳过异常,或返回错误代码 | tryCreate |
后缀 | OrDefault | 尝试运行,如果不成功返回默认值 | getOrDefault |
后缀 | OrElse | 尝试执行并在失败时返回参数指定的值 | getOrElse |
前缀 | force | 试着强迫它。错误由异常或返回值表示 | forceCreate , forceStop |
与异步处理相关的方法
位置 | 单词 | 意味 | 例 |
---|
前缀 | blocking | 阻塞线程的方法 | blockingGetUser |
后缀 | InBackground | 在后台线程中执行的方法 | doInBackground |
后缀 | Async | 异步方法 | sendAsync |
后缀 | Sync | 同步方法(有对应的异步方法) | sendSync |
前缀或词干 | schedule | 队列作业和任务 | schedule , scheduleJob |
前缀或词干 | post | 同上 | postJob |
前缀或词干 | execute | 执行异步处理 | execute , executeTask |
前缀或词干 | start | 同上 | start , startJob |
前缀或词干 | cancel | 停止执行异步处理 | cancel , cancelJob |
前缀或词干 | stop | 同上 | stop , stopJob |
回调方法
位置 | 单词 | 意味 | 例 |
---|
前缀 | on | 发生某事时执行 | onCompleted |
前缀 | before | 在事情发生之前执行 | beforeUpdate |
前缀 | 前缀 | 同上 | 前缀Update |
前缀 | will | 同上 | willUpdate |
前缀 | after | 有事就跑 | afterUpdate |
前缀 | post | 同上 | postUpdate |
前缀 | did | 同上 | didUpdate |
前缀 | should | 在询问是否会发生某些事情时执行 | shouldUpdate |
操作集合的方法
单词 | 意味 | 例 |
---|
contains | 它是否与您指定的对象具有相同的对象 | contains |
add | 加上 | addJob |
append | 同上 | appendJob |
insert | 添加到第 n 个 | insertJob |
put | 添加key对应的元素 | putJob |
remove | 删除元素 | removeJob |
enqueue | 添加到矩阵的末尾 | enqueueJob |
dequeue | 取出矩阵的开头并删除它 | dequeueJob |
push | 添加到栈顶 | pushJob |
pop | 取出堆栈的顶部并将其删除 | popJob |
peek | 移除栈顶(不要从栈中移除) | peekJob |
find | 找到符合条件的那个 | findById |
状态方法
单词 | 意味 | 例 |
---|
ensure | 检查预期状态,否则抛出异常或返回错误代码 | ensureCapacity |
validate | 检查正确的状态,否则抛出异常或返回错误代码 | validateInputs |
处理对象生命周期的方法
单词 | 意味 | 例 |
---|
initialize | 初始化。也作为延迟初始化方法。 | initialize |
abandon | 析构函数替代 | abandon |
destroy | 同上 | destroy |
dispose | 同上 | dispose |
与数据相关的方法
单词 | 意味 | 例 |
---|
create | 做一个新的 | createAccount |
new | 做一个新的 | newAccount |
from | 从现有数据创建一个新数据,或从另一个数据创建一个新数据 | fromConfig |
to | 转变 | toString |
update | 重写现有的 | updateAccount |
load | 读 | loadAccount |
fetch | 读(远程) | fetchAccount |
delete | 删除 | deleteAccount |
remove | 删除 | removeAccount |
save | 保存 | saveAccount |
store | 保存 | storeAccount |
commit | 保存 | commitChange |
apply | 保存/应用 | applyChange |
clear | 清除数据或返回初始状态 | clearAll |
reset | 清除数据或返回初始状态 | resetAll |
成对的单词
单词 | 单词 |
---|
get获取 | set 设置 |
add 增加 | remove 删除 |
create 创建 | destory 移除 |
start 启动 | stop 停止 |
open 打开 | close 关闭 |
read 读取 | write 写入 |
load 载入 | save 保存 |
create 创建 | destroy 销毁 |
begin 开始 | end 结束 |
backup 备份 | restore 恢复 |
import 导入 | export 导出 |
split 分割 | merge 合并 |
inject 注入 | extract 提取 |
attach 附着 | detach 脱离 |
bind 绑定 | separate 分离 |
view 查看 | browse 浏览 |
edit 编辑 | modify 修改 |
select 选取 | mark 标记 |
copy 复制 | paste 粘贴 |
undo 撤销 | redo 重做 |
insert 插入 | delete 移除 |
add 加入 | append 添加 |
clean 清理 | clear 清除 |
increase 增加 | decrease 减少 |
play 播放 | pause 暂停 |
launch 启动 | run 运行 |
compile 编译 | execute 执行 |
debug 调试 | trace 跟踪 |
observe 观察 | listen 监听 |
build 构建 | publish 发布 |
input 输入 | output 输出 |
encode 编码 | decode 解码 |
encrypt 加密 | decrypt 解密 |
compress 压缩 | decompress 解压缩 |
pack 打包 | unpack 解包 |
parse 解析 | emit 生成 |
connect 连接 | disconnect 断开 |
send 发送 | receive 接收 |
download 下载 | upload 上传 |
refresh 刷新 | synchronize 同步 |
update 更新 | revert 复原 |
lock 锁定 | unlock 解锁 |
check out 签出 | check in 签入 |
submit 提交 | commit 交付 |
push 推 | pull 拉 |
expand 展开 | collapse 折叠 |
begin 起始 | end 结束 |
start 开始 | finish 完成 |
enter 进入 | exit 退出 |
abort 放弃 | quit 离开 |
obsolete 废弃 | depreciate 废旧 |
collect 收集 | aggregate 聚集 |
参考资料:方法命名的参考信息 qiita.com/KeithYokoma…