IDEA 命名补全插件,用了就停不下来!

7,482 阅读5分钟

在写代码的时候,离不开创建类、写函数、写方法、定义变量,因此少不了为此命名。

作为程序员的基本素养,不仅要写出有质量的代码,也要让人看的懂你的代码。遵循用英文单词来规范来命名尤为重要。

一个好的命名不仅能清晰的表达代码在上下文中的意图,也能提升代码质量和减少沟通成本。在协同开发发挥出很好的作用。

img

好了 ,主角来了...

1638592120(1).png

命名提示插件

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

兼容性

img img img img

特性

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

演示

Screenshot 2

更多

关于TpyingCat插件交流,请移至Github,欢迎star和提出issue

Github - TypingCatPlugin




额外干货单词命名规范表():

返回值为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
loadloadAccount
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…