关于命名的一点建议
首先声明:只是由于个人的强迫症才有的一点点小建议。
《同类项前置命名法》(暂时不知道有没有学名)
即我们平时给文件命名或者给变量命名的时候,可以把相同的部分前置
。
举个例子: 在 editor-extensions/extensions/inspector/source
中,有如下几个文件夹
bash
├── browser
├── contributions
├── curve-editor
├── gradient-editor
├── panels
├── scene
└── sprite-editor
那么根据 同类项前置命名法
则应该如下命名
bash
├── browser
├── contributions
├── editor-curve
├── editor-gradient
├── editor-sprite
├── panels
└── scene
这样3个 editor
不约而同的处在了相邻的位置,审阅代码的时候更加直观。(我们很快知道这个目录下存在3个 editor 文件夹,分别是 cuve 、 gradient 、sprite )。
那么业内有没有比较好的实践呢?我们来看看几个常见的 web api
- drag
- dragstart
- dragover
- dragenter
- dragleave
- dragend
还有
- mouseenter
- mousemove
- mouseleave
都是相同的字符串在前面,看着非常清爽。这样的命名方式有一种天然的归类能力。无需其他,我们就能知道这个几个东西是一个组合。
结尾
同类项前置命名法
对代码无侵入性,也不会影响任何结构。只是稍微改一下命名习惯,就能给项目工程的可读性带来一定提升。