代码不规范,同事皮锤现(下)
Posted suihang
tags:
篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了代码不规范,同事皮锤现(下)相关的知识,希望对你有一定的参考价值。
这篇是代码规范系列的最后一篇了,前两篇说了一些注意的点,最后一篇再来补充一下子,开工
参数验证
关于参数验证这一点我想大家都不陌生了,React,Vue都可以对父组件传进来的参数进行验证,而函数里面通常也可以对传进来的参数进行验证,当然,不加验证只要传参正确也是没有问题的,但是假设我们要对传入的参数类型进行限制,还是需要把参数验证加上的,起码能让我们的程序写起来更加规范,与同事之间进行迭代开发也能更快的上手。
主动抛错
啥叫主动抛错呢,跟主动承认错误是一个意思吗,做错了事情赶紧承认,在代码中我们可以通过throw来主动抛出错误,这里可能有的同学要问,当代码出错,浏览器上不是会自动抛出错误吗?为何还要脱了裤子放屁多此一举呢,其实不然,浏览器的错误可能没有我们自己定义的详细,毕竟你自己抛出的错误,想抛出什么就抛出什么,这样后期代码中一旦抛出错误,就能快速的定位到问题的原因。
我们常用throw和try catch来抛出错误,而常见的错误类型也不外乎以下七种
Error:所有错误的基本类型
ReferenceError: 期望的对象不存在时发生,比如变量未定义直接使用
TypeError: 变量不是期望的类型时抛出,例如a是一个字符串,调用a()
EvalError:eval函数执行发生错误时抛出,现在已经非常不提倡用eval了
SyntaxError: 给eval传递的代码中有语法错误时抛出
RangeError:数字超过他的边界时抛出,比如创建一个长度-10的数组会抛出该错误,正常代码中也非常罕见
URIError:给encodeURI(),encodeURIComponent(),decodeURI()或者decodeURIComponent()等函数传递格式非法的URI字符串时抛出错误
最常见的则是ReferenceError,TypeError。
分离配置数据
啥叫配置数据呢,通俗来说就是你在代码中写死的数据吗,比如URL,重读的值等等,这些我们在后期维护升级的时候可能会改动的值都抽离出来,单独的放到一个对象或者统一的文件中去,当后期更改的时候就不需要再去代码逻辑中更改,只需要去改对应的配置项即可。
洁身自好
啥叫洁身自好呢,就是管好你自己,不要乱动别人的对象,当单人开发的时候还好,因为所有的函数心里都有数,协作开发的时候就比较麻烦。为啥在协作开发中要洁身自好呢,因为随便修改或者覆盖方法很容易影响到别人,所以在进行函数修改或者覆盖的时候我们一定要慎重,防止把同事的部分也搞崩。真搞崩了你看你同事扎不扎你就完事了。当我们自己的对象不想被其他人修改的时候我们可以使用以下三种方案来保护他
防止扩展:Object.preventExtension(对象名) 禁止为对象添加属性方法,但已存在的属性可以被删除或者修改
密封:Object.seal(对象名) 类似防止扩展,但是只可以修改属性,不可以删除
冻结: Object.freeze(对象名) 类似密封,但是禁止修改已存在的属性和方法。增删改啥都干不了
注释
注释是必不可少的,当然如果你的代码规范水平达到了让人一眼就能看懂的境界,就不需要写注释了。否则还是把注释写上吧,写注释尽量写在关键的地方,不需要每一行都带着注释,只需要在函数开头注明函数的操作,或者在不容易理解的地方注释一下就好
最后的大招,吃我一记ESlint
这真真的算是大招了,开开ESLint配置好什么空格缩进啊,换行啊等等,只要你写的不符合规范就会给你抛出警告提示。美滋滋,具体的配置方案网上的教程多如牛毛,随便搂一篇过来参考一下就好。用上之后你会发现代码优美的一匹!
当当当当,OK了,关于代码规范的知识暂时就想到这些,后面要是发现其他的我会在回来继续补充的,溜了溜了,趁着夜深人静赶紧去洗个脚,按个摩啥的
以上是关于代码不规范,同事皮锤现(下)的主要内容,如果未能解决你的问题,请参考以下文章
AI根据代码内容自动起函数名,再也不怕命名不规范的同事了|开源