代码的坏味道——精准命名

        前言:写好高质量的代码就应该从小事做起。一个好的变量名更应该从语义知道这个变量是在干什么事情。

        命名:这是我们定义变量、方法必不可少做的一件事情,可是你真的去用行动对每一个变量做到精准命名了吗?嗯没错,确实没有,如果想把这个事情做好,其实是非常耗时间和经历的。但是如果前期去用心定义一个变量,是比你之后(重构/迭代)代码省很多的时间。

目录

一、避免使用模糊的命名

二、避免使用缩写的命名 

三、避免使用技术关键字

四、避免使用多种命名规范

五、避免使用数字序列命名

一、避免使用模糊的命名

每个变量都比较模糊,如果随便拿出一个变量来看,并不知道具体是在做什么。

badCase:

const detail = {}
const flag = false
const text = ''

goodCase:

  1. detail 可以重写为 userInfoproductDetail 或 errorDetail,具体取决于它所表示的详细信息的类型。
  2. flag 可以重写为 isActivehasError 或 isLoaded,具体取决于布尔值所表示的含义。
  3. text 可以重写为 errorMessagedisplayText 或 userInput,具体取决于文本的用途或来源。

二、避免使用缩写的命名 

尽量使用单词的全称,而不是进行简写会变得过于模糊,使变量不清晰。

badCase:

const tLoading = false;
const errMsg = '';
const btnText = ''

goodCase:

const tableLoading = false;  //  tLoading中的t过于宽泛,很难一眼理解出t的含义

const errorMessage = '';  // errMsg 过于简略

const buttonText = '' // btn过于简略

三、避免使用技术关键字

技术关键字容易和命名进行混淆。

badCase:

const class = '';
const name = '';
const object = {};

goodCase:

 const cardClass = ''"; cardClass更容易表示出卡片分类

 const userName = "" ; shopName更容易表现出是用户名称

 const userInfo = { } ;更容易表示出是用户信息的集合

四、避免使用多种命名规范

考虑的命名规范例如:小驼峰、烤串、下划线,并保持一种写法

badCase:

const user_Info = {};
const userList = [];

goodCase:

const userInfo = {};  // 保持一种规范写法

const userList = [];

 五、避免使用数字序列命名

数字序列的方式对每个命名的关系欠缺描述

badCase:

const data1 = []
const data2 = []
const data3 = []

goodCase :

const categoryList = [ ];

const userList = [ ];

const cardList = [ ];

  • 3
    点赞
  • 7
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值