42 lines
1.6 KiB
Plaintext
42 lines
1.6 KiB
Plaintext
|
# 项目背景
|
|||
|
|
这是一个基于uniapp的任务接单微信小程序，主要用于发布任务、接单、完成任务等。
|
|||
|
|
|
|||
|
|
# 主要框架
|
|||
|
|
- Vue2
|
|||
|
|
- UniApp
|
|||
|
|
- UniUi
|
|||
|
|
|
|||
|
|
# 样式标准
|
|||
|
|
- 需要简洁、美观、大方，符合现代APP的视觉和交互规范
|
|||
|
|
|
|||
|
|
# 编码标准
|
|||
|
|
- 变量和函数名使用 camelCase 规范，组件名使用 PascalCase
|
|||
|
|
- 组件的样式使用 scoped 属性，避免样式污染
|
|||
|
|
- 样式使用scss
|
|||
|
|
- props、data、methods、computed、watch 生命周期函数等都使用驼峰命名
|
|||
|
|
- 对于全局能够重复使用的组件，尽量封装成组件，并放在 components 目录下
|
|||
|
|
- 对于业务能够重复使用的组件，尽量封装成组件，并放在 pages/{模块名}/components 目录下
|
|||
|
|
- 所有请求都需要在 api/{模块名}.js 文件中定义，并保持统一的命名规范，使用时统一调用
|
|||
|
|
- 业务操作尽量封装成方法或组件
|
|||
|
|
- 保持与现有代码风格一致
|
|||
|
|
- 代码需要具有可读性，注释清晰，后续可拓展
|
|||
|
|
- 使用Promise风格来实现请求，切勿使用 await
|
|||
|
|
- 使用dart-sass来编写scss
|
|||
|
|
|
|||
|
|
-
|
|||
|
|
|
|||
|
|
# 项目结构
|
|||
|
|
- api 目录下存放接口文件
|
|||
|
|
- static 目录下存放静态资源
|
|||
|
|
- components 目录下存放全局组件
|
|||
|
|
- pages 目录下存放页面
|
|||
|
|
- utils 目录下存放工具类
|
|||
|
|
- utils/enums.js 目录下存放枚举常量
|
|||
|
|
- utils/index.js 目录下存放工具类
|
|||
|
|
- pages 目录下存放业务相关页面
|
|||
|
|
|
|||
|
|
# 文档规范
|
|||
|
|
- 使用 JSDoc 格式编写函数和组件的注释
|
|||
|
|
- 组件必须包含 PropTypes 验证
|
|||
|
|
- 每个主要目录必须包含 README.md 文件
|
|||
|
|
- 同时提供英语和中文版本的 README.md 文件
|