人人都会AI编程

6.2 项目目录导航

更新时间:2026-06-28

基本原则:三层以内
理想的项目结构应该能在三层目录内找到任何文件。超过三层,说明需要重构或添加索引文档。

标准结构示例

project/
├── docs/               # 文档(不是doc,用复数)
├── src/ 或 app/        # 源代码(别用code)
├── tests/ 或 __tests__/# 测试文件
├── config/             # 配置文件(别和conf混用)
├── scripts/            # 构建/工具脚本
├── assets/ 或 static/  # 静态资源
└── README.md           # 必须有的地图

命名硬规则

  • 全小写,用连字符(my-utils)而非下划线(my_utils)或驼峰(myUtils)
  • 单数还是复数?统一即可:要么全用model/ view/,要么全用models/ views/,不要混用

导航技巧

  1. README.md 是地图:每个子目录如果超过3个文件,必须放README.md说明该目录用途
  2. IDE 书签:用 VS Code 的 Ctrl+P 或 JetBrains 的 Shift+Shift,别手动点文件夹
  3. 终端别名:在 .bashrc.zshrc 里加:
   alias ..="cd .."
   alias ...="cd ../.."
   alias p="pwd"  # 随时确认位置
   

避坑指南

  • 不要按文件类型分(如把全项目的 CSS 放一个文件夹),按功能模块分(user/ 下面有 .js 也有 .css)
  • 不要有 utils/ helpers/ misc/ 这种垃圾桶文件夹,临时文件用完即删
  • 空文件夹不要提交到 git,用 .gitkeep 是坏习惯,说明结构设计失败

检查清单
新增文件前问自己:如果半年后凌晨2点报错,我能在30秒内找到这个文件吗?如果不能,现在就改路径。