Skip to content

后台前端开发规范

Jump to bottom
liaofei edited this page Jan 20, 2021 · 1 revision

CRMEB Admin

开发规范

统一使用ES6 语法 方法注释 /*

  • th => 表头
  • data => 数据
  • fileName => 文件名
  • fileType => 文件类型
  • sheetName => sheet页名 */ export default function toExcel ({ th, data, fileName, fileType, sheetName }) 行注释 //

命名

页面目录 文件夹命名格式骆驼式命名法,例如：用户列表 userList 例如：商品模块 product 商品 ├─ product 商品管理 ├─productList 商品管理目录 ├- index.vue 首页 ├─ components 组建 ├─ tableFrom.vue ├─ tableList.vue ├─ handle 操作功能页面目录 ├─ delete.vue ├─productCategory 商品分类目录 ├─ index.vue 商品分类首页

页面命名、组建、文件夹 命名格式小驼峰命名法,例如：用户列表 userList

类名函数命名 小驼峰式 例如：addUser 变量命名 小驼峰式 例如：user 或者 userInfo _userinfo user-info 常量 采用全大写下划线命名 例如：VUE_APP_API_URl

文件管理规范

pages         页面模块必须建文件夹区分
api           接口一个模块一个文件
components    一个组建一个文件夹
plugins       插件一个插件一个文件夹
vuex          路由状态管理，一个模块在modules 中建一个文件
router        一个模块一个模块在modules 中建一个文件
style         样式尽量采用iView自带组建，common.less 系统通用样式不要轻易动
style         style.css自定义全局样式
utils         自定义工具js 独立命名，一般不用新建文件夹

模块命名

├─ account 有关登录页
├─ app 应用（小程序模板消息、公众号）
├─ cms 文章管理
├─ finance  财务管理
├─ index 主页
├─ marketing 优惠券、积分
├─ notify 短信账户、短信购买、短信模板
├─ order 系统订单管理
├─ product 商品管理
├─ setting 系统设置、运费模板、可视化等
├─ system 开发配置、安全维护等
└─ user 用户管理
Clone this wiki locally