美文网首页
命名规范

命名规范

作者: YQY_苑 | 来源:发表于2018-01-31 17:12 被阅读0次

    1. 注意词性

    • 普通变量/属性 用【名词】
    var person = {
          name : 'YQY'
    }
    var student = {
           grade : 3,
           class  : 2
    }
    
    • bool变量/属性用 【形容词】 或者 【be动词】或者【情态动词】 或者 【hasX】
    var person = {
           dead : false , 
           //如果是形容词,前面就没必要加is,比如isDead就很废话
            canSpeak : true,
           //情态动词有can,should,will,need 等,情态动词后面接动词
            isVip : true,
           //be动词又is,was等,后面一般街名词
            hasChildren : true,
           
    }
    
    • 普通函数/方法 用【动词】开头
    var person = {
            run(){}, //不及物动词
            drinkWater(){}//及物动词
    }
    
    • 回调、钩子函数 用【介词】 开头,或用【动词的现在完成时态】
    var person = {
       beforeDie(){},
       afterDie(){},
        //或者
        willDie(){},
        dead(){}
    // 这里跟bool冲突,你只要不同时暴露bool dead 和函数 dead 就行
    }
    button.addEventListener('click',onButtonClick)
    var component = {
        beforeCreate(){},
        created(){},
        beforeMount(){},
        mounted(){},
        updated(){},
        activated(){},
        deactivated(){},
        beforeDestroy(){},
        destroyed(){},
        errorCaptured(){}
    }
    
    • 容易混淆的地方加前缀
    div1.classList.add('active') //DOM对象
    div2.addClass('active')  //jQuery 对象
    //不如改成
    domDiv1 或 elDiv.classList.add('active')
    $div2.addClass('active')
    
    • 属性访问器函数可以用名词
    $div.text() //其实是$div.getText()
    $div.text('h1')  //其实就是$div.setText('h1')
    

    2. 注意一致性

    • 介词一致性
      如果使用before + after , 那么就在代码的所有地方都坚持使用
      如果使用before + 完成时,那么久坚持使用
      如果一致性不能保证,将会导致【不可预测】

    • 顺序一致性
      比如 updataContainerWidth 和 updataHeightOfContainer 的顺序就令人很变扭

    • 表里一致性
      函数名必须完美体现函数的功能,既不能多也不能少

    相关文章

      网友评论

          本文标题:命名规范

          本文链接:https://www.haomeiwen.com/subject/rlhpoxtx.html