目录结构
目录 | 描述 |
---|---|
public | 公共资源目录 |
src | 开发资源目录 |
src/api | 后台接口请求 |
src/assets | 静态资源目录 |
src/components | 公共组件目录 |
src/composables | 组合式函数 |
src/layout | 公共布局 |
src/mixins | 混入 Mixin |
src/router | 路由 |
src/store | 状态 |
src/styles | 公共样式 |
src/utils | 公用函数及类库 |
src/views | 页面目录 |
src/views/index.vue | 默认首页 |
App.vue | 入口页面 |
main.js | 入口脚本 |
开发规范要求
- 每个独立的功能,需要在 src/views 目录中创建一个子目录。
- 目录、文件、类、变量等命名,要使用简洁明了能表达其正确用途的英文单词或词组。
- 命名使用首字母小写的驼峰式命名,如果组件、类库、函数、目的是为了外部使用,为方便可以使用首字母大写的驼峰式命名
- 尽可能多的使用中文注释,尽可能使用符合 JSDoc 规范的注释,特别是api部分
- 图片等资源优先放置在public目录中,例如:public/images
- 不要为解决业务需求,添加公共样式。组件样式,不要产生污染(请使用scoped)。
关于公共组件的开发
- 如果有能力,建议自行开发,也可以协商开发。
- 作为公共组件,请尽可能从眼前的需求延伸到后期被复用时可能产生的新需求。
- 不要在公共组件中判断某个业务的逻辑。