命名规范

3,364 阅读2分钟

文件夹规范

  1. 当页面文件具有私有组件(component)、指令(direction)和过滤器(filter)时,建立一个与页面同名的文件夹,页面文件更名为index.vue,将页面与相关的依赖文件放在一起。
  2. 文件夹由全小写的名词、动名词或分词命名,由两个以上的词组成,以“-”进行分隔。

文件规范

  1. Vue文件统一以大驼峰命名法命名,进入口文件index.vue采用小写。
  2. 测试文件一律以测试目标文件名.spec.js命名。
  3. 资源文件一律以小写文件字符命名,由两个以上的词组成以“-”进行分隔。
  4. HTML、CSS文件命名规范:确保文件命名总是以字母开头而不是数字,且字母一律小写,以下划线连接(_)且不带其他标点符号。
  5. js文件命名规范:字母全部小写,不要带空格,用破折号(-)连接单词。

命名规范

  1. 变量命名:小驼峰式命名方法,建议类型+对象描述的方式,如果没有明确的类型,就可以使前缀为名词。
  2. 函数命名:小驼峰方式 ( 构造函数使用大驼峰命名法 ),前缀为动词。
  3. 常量命名:全部大写,使用大写字母和下划线来组合命名,下划线用以分割单词。
  4. 类的成员:公共属性和方法 : 同变量命名方式;私有属性和方法 : 前缀为下划线(_)后面跟公共属性和方法一样的命名方式。
  5. 注释规范:参考下面链接

驼峰命名方式

  1. Pascal Case 大驼峰式命名法:首字母大写。eg:StudentInfo、UserInfo、ProductInfo。
  2. Camel Case 小驼峰式命名法:首字母小写。eg:studentInfo、userInfo、productInfo

参考链接

  1. 前端开发规范
  2. html、css规范