-- 创造无限可能

javascript开发:命名规范

2023-05-13 23:25:44
551 人浏览 9 人点赞
有用,点赞支持一下

为什么需要命名规范

  1. 为了以后的自己能理解和维护自己以前写的代码
  2. 为了方便理解和维护同一个团队里面别人写的代码
  3. 为了方便同一个团队里面别人理解和维护自己写的代码

怎么定制命名规范

  1. 不同公司有不同的约定,具体根据自己公司的情况自己
  2. 简单
  3. 语义化

命名规范约定什么

  1. 变量
  2. 常量
  3. 方法和函数
  4. 类的定义
  5. 注释

以下是一套javascript开发命名规范,可以根据自己需要调整

  1. 变量
    1.1 小驼峰命名法:第一个单词首字母小写,其他单词首字母大写,例如 firstName
    1.2 布尔类型变量应使用 is, has, can 等前缀,例如 isCompleted
    1.3 由字母、数字、下划线、$符号组成,不能以数字开头,以下是不好的例子123name,#abc
    1.4 变量名区分大小写
    1.5 不能使用保留的关键字、保留字、truefalsenull

  2. 常量名
    使用全大写字母,单词之间使用下划线分隔,例如 MAX_NUMBER

  3. 函数和方法
    3.1 小驼峰命名法:第一个单词首字母小写,其他单词首字母大写,例如 getName
    3.2 函数和方法都是表示对什么东西进行操作,建议第一个单词是动词,名词在后面,例如 getUserList


  4. 4.1 类名使用大驼峰命名法,每个单词第一个字母大写,例如 Person

  5. 变量名应该避免音译命名,应该使用英文单词或者常用缩写来进行命名。例如使用 load 而不是 lode。

  6. 缩写应该当获取远离语境并且广为人知。例如 URL 是广为人知的缩写。

  7. 避免使用单字母命名,除非是一个已经被广泛接受的惯例,例如 i 用于循环中所索引的变量命名。