美文网首页
命名规范

命名规范

作者: 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 的顺序就令人很变扭

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

相关文章

  • 适合各厂使用的 MySQL 团队开发规范,太详细了,建议收藏!

    数据库对象命名规范 数据库对象 数据库对象全局命名规范 数据库命名规范 表命名规范 字段命名规范 索引命名规范 视...

  • 代码书写规范

    res命名规范: src中命名规范: 习惯命名:

  • Android开发中的优化方案

    一、命名规范 代码规范先从命名规范开始,Android的命名规范主要涉及:Java源代码,xml文件,图片资源。 ...

  • Swift--规范编程

    命名规范 注释规范 声明 代码排版 命名规范 常用命名方法 匈牙利命名,一般只是命名变量,原则是: 变量名 = 类...

  • Flutter 代码规范

    命名规范 命名规范中包括了文件以及文件夹的命名规范,常量和变量的命名规范,类的命令规范。Dart 中只包含这三种命...

  • 入门13 CSS综合

    CSS编码规范 命名规范:语义化标签优先;基于功能命名、基于内容命名、基于表现命名;简略、明了、无后患 书写规范:...

  • 规范文档

    1.命名规范2.注释规范3.代码规范4.目录规范 1.命名规范 通用规范通用规范是在整个项目中,所有的命名都需要遵...

  • 内部前端规范v1.0

    项目目录结构规范 请查看 项目目录结构规范 HTML 命名规范 class 命名实行 BEM命名方式。关于BEM,...

  • [知识点滴]Div+CSS命名规范大全

    Div+CSS命名规范(前端web开发命名规范)Div+CSS命名规范(一)窗体头:header内容:conten...

  • 2018-06-28 python命名规范

    Python命名规范 Google Python****命名规范 module_name, 模块 package...

网友评论

      本文标题:命名规范

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