# 技术规范

# 开发基础规范

  • 项目业务开发,优先使用 vue 全家桶技术栈开发项目,预编译使用 sass;
  • 代码规范按照 eslint 的规则来,做到 no waring 和 no error;
  • 重要、复杂逻辑一定要写注释;
  • 项目根目录说明文档(项目简介、主要技术栈、访问域名);
  • 使用 webpack 打包,vue3 项目使用 vite 打包;
  • 模块说明文档(在 views 的模块创建 md 文件补充,包含如接口地址、组件说明、ui 设计地址等)
  • 操作成功或失败后要有提示,比如新增成功、新增失败运行时间长的任务(计算量大、请求后台接口),要有 loadding 效果;
  • vue 单文件组件代码规范,html、script、style 的位置顺序 html > script > style;
  • 公共的状态才放到 store;
  • js 字符串用单引号,html 属性用双引号;
  • 代码尽量往纵向发展,一行不要太长;
  • 不要在钩子函数中写大量业务代码;
  • 异步使用 aysnc await 语法;
  • 不是常用的方法不要全局挂载;

# 项目质量与验收

  • 根据项目进度,适时安排代码 review(注:新人项目着重关注首次代码 review);

# 其他

  • 新建项目架构,可借鉴现已有项目架构(保持风格统一);
  • UI 设计,组件请尽可能使用 vant 组件库;