项目初期准备(二)

除了项目架构中使用`eslint`,`stylelint`,`prettier`中的规范外,项目开发中须遵循如下规范:

- 公共组件首字母必须大写,包括文件夹和文件,即./components 下的文件
  - 示例 `components/Layout/Sidebar.vue`
- `./src`一级目录不允许创建除现有外的其他目录
- 关键变量和函数,尽可能要添加注释
  - 变量,使用`//`注释,如`// 数量`
  - 函数,使用`/** */`注释,必须要说明参数的含义
- CSS 命名
  - 名称全部以`-`连接
  - `不`允许使用`驼峰命名`
  - `不`允许`大写`
  - `不`允许使用拼音,或拼音缩写,建议使用英文单词或英文缩写
- JS 命名
  - 以`头字母小写`的驼峰命名方式,如 userName
  - `不`允许使用`_`下划线,参数临时变量外,示例:(\_, t) => { return t}
  - `不`允许使用`-`下划线、
  - `不`允许使用`var`建议使用`let` `const`
- 图片命名
  - 全部使用小写
  - 使用`_`连接
  - `不`允许使用`大写字母`
  - `不`允许使用`驼峰命名`
- 路由命令
  - name 驼峰命名, 首字母大写
  - path 绝对路径
  - router 中涉及国际化的语言,使用`i18n`的 key 值

 各项要求视情况而定

集思广益,仅供学习,侵权即删!!
原文地址:https://www.cnblogs.com/hudunyu/p/13437237.html