03Js代码优化-函数命名的艺术

197 阅读1分钟

Offer 驾到,掘友接招!我正在参与2022春招系列活动-刷题打卡任务,点击查看活动详情

这篇文章分享的内容来自B站up主 红桃A士的《改善丑陋代码》的系列视频,主要是视频内容的笔记和总结。

一、函数命名要求

  1. 函数命名应该尽可能的表达出函数的作用
  2. 高质量函数命名可以让函数体本身或者是被调用时无需注释
  3. 函数命名应该偏重函数的功能而非执行过程

二、判断型函数命名

  • 普通方法和工具方法:前缀词 + 名词 + 动词(is/can/has/...+something+verb)
  • 类方法:前缀名 + 名词(is/can/has/...+something)

前缀词

  • is:表示是否符合的状态
  • can:表示能否执行的状态
  • has/includes/contains:表示是否包含的状态
  • should/needs:表示是否需要的状态

函数命名修改示例如下: image.png

三、数据获取型函数命名

  • 对于数据获取型函数,都使用get做为前缀的话,不能直观看出是通过什么方式获取数据的,我们可以通过使用不同的前缀词来表达获取方式

1、直接从对象、数据结构中获取数据

  • 使用get作为前缀词

image.png

2、通过计算获取数据

  • 使用calculate/cal作为前缀词

image.png

3、从数据库查找数据

  • 使用find/query作为前缀词

image.png

4、从配置文件加载数据

  • 使用load/parse/build作为前缀词

image.png

5、网络请求获取数据

  • 使用fetch作为前缀词

image.png