uniapp目录变量命名开发规范

uniapp目录变量命名开发规范

1.常规开发目录

├── api             // 统一接口目录
│   └── user.js     // 用户接口 (按功能分组)
├── common          // 公共目录
│   ├── common.js   // 公共函数 
├── components      // 公共组件目录
├── pages           // 页面
│   ├── index
│   │   └── index.vue
│   ├── login      
│   │   ├── login.vue   
│   │   └── register    
├── static          // 静态资源 (css/js/图片/声音等等)
│   ├── images
│   │   ├── category.png
├── store           // vuex缓存
│   └── index.js
└── utils           // 工具目录
    └── request.js  // http请求库
├── App.vue         
├── main.js         // 入口文件
├── manifest.json   // uniapp配置文件
├── pages.json      // 页面配置
├── uni.scss        // 公共样式
├── README.md       // 自述文件

2.文件夹命名规范

命名一定要有意义, 有辨识度

搜索: search.vue
购物车: confirm-order.vue

有些页面文件名和位置必须固定

举个栗子: 创建有关商品(goods)的页面;	
	列表页: pages/goods/list.vue
	详情页: pages/goods/detail.vue

多个单词全小写 使用中划线分割

confirm-order.vue

3.代码命名规范

变量命名

命名: 驼峰命名, 首字母小写. 必须有意义
页面列表：List为后缀，如goodsList
页面详情：Details为后缀，如goodsDetails
页面状态值: 必须是bool类型, is作为前缀. 如: isShow

方法命名

跳转页面: to+目录名/页面名 toGoodsDetail(), toMy()
获取方法: get+变量名 getGoodsList()
更新方法: up+变量名 upIsShow()
提交方法: submit前缀 submitOrderData	(防快速点击: 提交数据需要做防止快速重复点击, 以3秒为例. 防止重复向服务器发送数据)

4.公共配置

所有用到地址的地方, 都必须从vuex缓存中获取

项目	注解
apiUrl	API地址
wsUrl	WebSocket地址
staticUrl	静态资源地址( 比如图片/js/css等)