Skip to content

Latest commit

 

History

History
36 lines (28 loc) · 1.09 KB

specification.md

File metadata and controls

36 lines (28 loc) · 1.09 KB

开发规范

一、命名规范

  • 项目命名:全部采用小写方式,以中划线分隔。例:my-project-name
  • 目录命名: 参考项目命名。有复数结构时,要采用复数命名法。例:scripts, styles
  • 文件命名:参照项目命名规则。例:account-model.js

二、格式规范

  • 缩进使用 tab 键,4空格
  • 嵌套节点需要缩进
  • 使用单引号,而不是使用双引号
  • 不需要在末尾添加分号

三、JavaScript 命名规范

  • 变量名采用驼峰命名法,例如myVariableName
  • 函数名采用驼峰命名法,例如myFunctionName
  • 常量名采用全大写,单词间用下划线分隔,例如MY_CONSTANT_NAME
  • 类名采用驼峰命名法,例如MyClassName
  • 事件名采用驼峰命名法,例如myEventName
  • 组件名采用驼峰命名法,例如MyComponentName

四、Git 提交规范

  • fix: 修复 bug
  • feat: 新功能
  • docs: 文档
  • style: 格式
  • refactor: 重构
  • perf: 性能优化
  • test: 测试
  • build: 构建
  • ci: 持续集成
  • chore: 其他修改