oneDrive网盘项目开发规范

---

前端

技术选型

• 使用 react , 统一使用函数式组件，Hook

样式编写

• 全局使用CSS
• 局部使用styled-component

网络请求

• 使用axios进行二次封装开发

路由

• react-router + react-router-config 管理路由

全局的风格组件

• 使用AntDesign中某些组件，避免重复造轮子

数据管理

• redux + ImmutableJS 保证数据的不可变性
• 异步请求代码使用redux-thunk

命名

• 文件夹、文件使用小写英文，多单词 - 连接
• 组件名使用大驼峰命名
• 变量名统一使用小驼峰命名
• 常量的字母 全部大写，单词之间用一个 下划线字符 _ 进行分隔

缩进

• 缩进一律使用tab = 2

注释

• 方法实现的功能、参数的详细含义、返回值的取值及其详细含义，都必须写明

代码

• 使用eslint检测代码
• 使用git创建分支管理项目
• 统一全部采用 Es6
• 组件统一使用自闭合方式

---

后端

技术选型

• 使用 node.js(版本14.15) + koa2 + axios

网络请求

• 使用axios进行二次封装开发

路由

• koa-router分模块编写代码，遵循REST API规范

数据处理

• koa-bodyparser接收请求参数

开发

• 使用nodemon热更新

注释

• 方法实现的功能、参数的详细含义、返回值的取值及其详细含义，都必须写明

具体开发步骤见下一章
有 任何建议/问题 请留言评论哦