js变量命名规范

变量规范

概述

::: warning
1.命名规范请认证阅读，约束不是目的，统一风格是为了方便代码阅读，见名知意，后期代码维护方便；
2.有些地方也相对开放，最终目的是要简洁明了，表意准确。
:::

关键字

关键字变量统一优先用es6+ 的let,const方式定义

使用var时需要注明原因和场景

变量名

1.使用小驼峰命名（第一个单词首个字母小写，其他单词首字母大写）
比如：fileName,vueRouter,orderList

 const fileName= ""
 const vueRouter= {}
 const orderList= []
 const useHook =()=>{}

2.使用单词全称，除非常用的单词缩写或单词组合太长的情况

变量一般不超过20个字符，尽量表意准确
单词组合太长，且不好表达意图的时候，可以根据单词重要性，缩略次要的单词

3.使用规范变量前后缀，不乱用关键类型词和数据结构词
比如：List,Obj,Array,Number,Num,Data,Str,Item等常用词

::: tip 数组
用 List,Array 等后缀或单词复数表示
:::

 //数组
 const orderList=[]
 const orderArray=[]
 let works=[]

::: tip 对象
用 Object,Obj,Data，Info，Bean 等后缀或对象单词表示
:::

 const userInfo={}
 const formData={}
 const orderObj={}
 let tomCat ={}

::: tip Map与Set
用 Map,Set 等后缀分别表示Map,Set结构
:::

 const eventMap=new Map()
 const elementSet=new Set()

::: tip 布尔
用 is,has,can 等前缀,或有判断意图的单词表示
:::

 # 是不是 
 let isEmpty=true
 # 有没有
 let hasExport=true
 # 能不能
 let canOpen=true
 
 let show =fasle

::: tip 数字
用 length,count,num,Number,Total 等后缀,或表示量词的单词表示
:::

 let fileLength= 1   
 const pollenCount =1 
 const rowTotal=100
 let limit=1

::: tip 字符串
用 Str,String,Json 等后缀或其他（字符串定义较开放）
:::

 let name= '张三'
 //url参数串  
 const paramStr="name=ppy&age=1" 
 //json字符串
 const argJson="{ "l1": { "l1_1":[ "l1_1_1"]}}"

函数名

1.使用小驼峰命名（第一个单词首个字母小写，其他单词首字母大写）
2.采用 动作特性开头的 组成结构
比如：

 const toggleMenu= (status)=>{}
 const setToken= (token)=>{}
 const resetForm= (ref)=>{}   

::: tip 通用情况
在不确定动作的单词的函数情况，推荐使用handle开头
:::

 const handleFilter= ()=>{}
 const handleFile= ()=>{}
 const handleSearch= ()=>{}   

::: tip 处理事件

对于明确组件事件动作的情况，也可以用事件key开头
比通用handle更具有明确的含义
:::

//点击编辑 
 const clickEditBtn= ()=>{}
//keyup键盘enter键
 const keyupEnter= ()=>{}
//鼠标浮出菜单事件
 const mouseOverMenu= ()=>{}