代码规范感受 —— 阅读《重构》、《clean code》收获
1、好的命名
在编码过程中一个好的命名非常的重要,不仅在《重构》中可以感受到,在我阅读《clean code》的时候的感受也非常的深刻。
-
一个好的命名首先要通俗易懂,可以很简单的通过命名就知道某个变量或者函数的作用或者存在意义。
-
如果某个函数需要注释来解释它的作用,那往往就以为着这个函数会有一个更好的命名来取代当前命名。
-
命名不应该有多个相近意义的存在,如:
formData、formInfo、form,这三个命名无法直观的分清楚它们之间的区别。 -
函数声明更多意义上是一个动作,可以根据返回值或者做了什么,如:
hasFn、isFn、setFn、getFn等等。 -
同一个单词不应该包含多种意义。例如
addFn,在一个方法中是将两个参数相加,在另一个中则是往数组中添加元素,可以使用其他单词替换,如:push、insert、append -
不应该在一个作用域中包含多个类似意义的函数声明,会让人无法区分,如:
xxController、xxManager -
函数名接近的情况下,可以统一命名顺序,让阅读者可以更快的分清楚区别,如:
handleButtonClick、handleButtonHover、handleButtonDoubleClick
2、函数封装
持续更新中...