Skip to content

项目目录结构规范

基础目录结构

根目录

├── src/                # 源代码目录
├── public/            # 静态资源目录
├── tests/             # 测试文件目录
├── docs/              # 项目文档目录
├── scripts/           # 脚本文件目录
├── config/            # 配置文件目录
└── package.json       # 项目配置文件

src 目录

src/
├── assets/           # 项目资源文件
│   ├── images/      # 图片资源
│   ├── styles/      # 样式文件
│   └── fonts/       # 字体文件
├── components/       # 公共组件
├── views/           # 页面组件
├── router/          # 路由配置
├── store/           # 状态管理
├── utils/           # 工具函数
├── api/             # API 接口
├── constants/       # 常量定义
└── App.vue          # 根组件

命名规范

目录命名

  1. 使用小写字母
  2. 多个单词用连字符(-)连接
  3. 语义化命名

文件命名

  1. 组件文件使用 PascalCase
  2. 工具文件使用 camelCase
  3. 样式文件使用 kebab-case

最佳实践

目录组织

  1. 按功能模块划分
  2. 保持目录层级清晰
  3. 避免过深的目录嵌套

文件组织

  1. 相关文件放在同一目录
  2. 公共资源集中管理
  3. 配置文件统一存放

代码组织

  1. 遵循单一职责原则
  2. 保持文件结构清晰
  3. 合理使用模块化

Released under the MIT License.