📛 命名规范

📔 文件命名

NOTE

文件名应该清晰、简洁，并且能够反映文件的功能。

• pages：创建pages下的文件夹时，按照MENU.js即菜单信息，按照小驼峰命名，当该菜单的页面有很多tab时应单独为一个文件夹如iqcManagement里的CheckSetting，pages保持与项目菜单统一结构。
• more...

📂 目录结构

NOTE

根据功能或模块将文件组织到不同的目录中，以提高代码的可维护性。

• components文件夹：
  • 公共/通用组件，按照大驼峰命名放在src下的components文件夹中，非公共/通用组件，放在当前的components文件夹中。
  • 当前文件夹里的components，是用于放置该菜单的组件如详情组件等，并以其调用的父组件名前缀xxxDetail命名（大驼峰）便于快速定位查找，父组件太长时可适当简写。
• api文件夹：
  • 接口文件按照MENU.js即菜单信息，按照小驼峰命名，添加接口时应按照页面、Controller进行归类，而不是随意添加在下面。
  • 添加接口时需检查调用名（apiName）是否有重复，如有重名的apiName需根据情况修改apiName，以防调错接口。

  // 如batchDelete为同名apiName 修改时建议是在尾部接上该Controller/组件/功能的前缀
  if (apiName == 'batchDelete' && controller == 'canningController') {
    apiName = 'batchDeleteCanning'
  }

• routeList文件夹：路由文件按照MENU.js即菜单信息，按照小驼峰命名，添加路由时应按照页面顺序进行添加并且填写对应的meta的信息。

NOTE

MES项目的结构大致如下

  web
  ├── favicon.ico        --网站图标   
  ├── index.html         -- 主页面
  ├─ .vscode             -- VSCode 本地项目配置、snippets等
  ├─ build               -- webpack 配置文件
  ├─ config              -- 开发和生产环境配置文件(可选1) 周迭代等webpack原生项目
  ├─ vue.config.js       -- 开发和生产环境配置文件(可选2) vue脚手架创建项目
  ├─ dist                -- 打包后生成的文件（npm run build）
  ├─ node_modules        -- 依赖文件（npm i）
  ├─ src
  │  ├─ assets           -- 静态资源文件,图片,字体等
  │  ├─ components       -- 全局组件
  │  ├─ fetch            -- API 接口管理
  │  ├─ pages            -- 项目所有页面
  │  ├─ router           -- 路由管理
  │  ├─ styles           -- 全局样式文件
  │  ├─ util             -- 常用工具库
  │  ├─ vuex             -- vue store
  │  ├─ App.vue          -- 项目主组件
  │  └─ main.js          -- 项目入口文件
  ├─ .babelrc            -- babel 配置文件
  ├─ .editorconfig       -- 统一不同编辑器的编码风格
  ├─ .eslintignore       -- 忽略 Eslint 校验
  ├─ .eslintrc.js        -- Eslint 校验配置文件
  ├─ .gitignore          -- 忽略 git 提交
  ├─ .prettierignore     -- 忽略 Prettier 格式化
  ├─ .postcssrc.js       -- postcss 配置
  ├─ .prettierrc.js      -- Prettier 格式化配置
  ├─ .stylelintignore    -- 忽略 stylelint 格式化
  ├─ .stylelintrc.js     -- stylelint 样式格式化配置
  ├─ package-lock.json   -- 依赖包包版本锁
  ├─ package.json        -- 依赖包管理
  ├─ README.md           -- README 介绍
  └─ STANDARD.md         -- 项目编码规范说明书