个人总结的前端命名规范

发布时间 2023-12-14 11:59:15作者: Zzp_zzZ
 
一个好的命名规范, 应该是简单的,方便记忆的;如非必要,不要新增新的命名规则;相似的类型,命名规则应该是一样,比如文件夹和文件名;差异很大的类型则需要有所区分,比如变量和常量的命名,因为常量是不能被修改的,内部变量和外部变量亦如此,人们可以借此很明显的区分是否可以函数区块外面使用;(通常来说 , 常量会是全大写,而函数内部变量会是下划线开头)(以当前项目的命名规范为第一优先)
 
以下是我编程时总结的一些经验,如果错误之处,或者更好改进的方式,烦请指正;
 
1.不要使用无意义的命名:比如getData()  ;首先,data具体你需要请求的是什么信息,获得Data,这样根本不能给人明确的信息,必须要联系上下文,甚至最后可能也很难去界定
 
2.区分应当严谨:在同系列的方法变量里面,使用诸如不同数字以区分,或者,新旧之间使用Old,New之类的前缀以区分。实际上不结合语境,他人是很难在一开始就有明确的理解的
 
3.不要使用关键字:很多IDE会报错,不易于别人理解,程序运行可能会炸
 
4.不要拼错词:这次拼错了,下次引用它,可能还需要继续拼错?如果后面拼对了,还就拿不到数据了,这无疑是很令人抓狂的。
 
5.不要使用中文拼音命名:就算英文无法准确的描述,但是尽量用英文,可以加上注释
 
6.不要胡乱缩写:实在缩不了,就别缩,否则沐猴而冠,不伦不类,反而更让人一头雾水
 
7.通常来说 如果是一个单词的缩写  会是首字母大写 比如 reference ---> Ref(参考查阅)
如果是多个词的缩写  就会是全大写 比如各种机构名称  the United States of America  --->USA    
 
8.对于事件函数要坚持严格的命名方法 尽量坚持onClickXX,onChangeXX,onBlurXX,这样的命名方式,统一的风格会让人更容易读懂;