微信小程序开发规范文档-项目结构

Posted 2021-03-01 jianxian

*项目结构

project/                    // 根目录
    ├─ images/              // 图片/小图标
    ├─ pages/               // pages目录
    ├─ utils/               // 工具，包文件目录
    ├─ app.js               // 入口文件                       
    ├─ app.wxss             // 公共设置
    ├─ app.json             // 公共样式表
    └─ project.config.json  // 项目的编辑器配置

页面目录

1.由历史原因和个人习惯导致目录命名不统一，语义不清晰，不同成员在维护时难以快速识别。

• 目录命名应遵循以下规范：

  • 尽量简短
  • 采用英文小写方式
  • 单词间以下划线连接
  • 英文语义需与当前目录实现的功能保持一致
  • 如有复数，应采用复数命名
  • 不应该出现数字和除下划线以外的特殊符号

• 示例：
  // 错误的写法
  ...
  ├─ pages/
  ├─ About/
  ├─ grouplist/
  ├─ group-list/
  ├─ group_list3/
  ├─ groupList/
  ├─ gl/
  ├─ yong_hu/
  ...

  // 正确的写法
  ...
  ├─ pages/
      ├─ about/
      ├─ group_list/
      ├─ users/
  ...
  

1. 小程序规定，一个页面由wxml，wxss，js，json四个文件组成。为了方便开发者减少配置项，描述页面的四个文件必须具有相同的路径与文件名。

• 示例：
  // 错误的写法
  ...
  ├─ home/
  ├─ index.wxml
  ├─ index.wxss
  ├─ index.js
  └─ index.json
  ...

  // 正确的写法
  ...
  ├─ home/
      ├─ home.wxml
      ├─ home.wxss
      ├─ home.js
      └─ home.json
  ...
  

  └ ┌ ┘ ┐ ┤ ├ ┴ ┬ ┼ │ ─