跳转到主内容
趣航编程网 - 趣学编程,启航技术之路!

创建VS Code工作区的推荐文件结构

答案:推荐以 .code-workspace 文件为核心,组织清晰的多目录结构,包含源码(src/)、本地库(libs/)、文档(docs/)、脚本(scripts/)和资源(assets/),并集中配置于 .vscode/ 目录,通过 settings.json、launch.json 和 tasks.json 统一团队开发环境,排除生成文件,按语言框架微调结构,提升可读性与协作效率。 VS Code 工作区(Workspace)本身不强制特定文件结构,但一个清晰、可维护的结构能显著提升协作效率和项目可读性。推荐以
.code-workspace
文件为核心,配合合理组织的源码、配置与文档目录。 核心:独立的
.code-workspace
文件 不要直接打开文件夹作为工作区——显式创建
.code-workspace
文件,便于统一管理设置和多根工作区。它本质是 JSON,可包含: folders :明确列出参与工作的本地文件夹路径(支持相对路径) settings :覆盖用户/语言级设置,如
"editor.tabSize": 2
、
"python.defaultInterpreterPath"
extensions :推荐团队安装的扩展(仅提示,不自动安装) launch 和 tasks :预置调试配置和构建任务,开箱即用 源码与资源:按职责分层,避免扁平堆积 工作区内的文件夹应反映逻辑边界,而非随意命名。常见合理划分:
src/
:主源码(含
main.py
、
index.ts
等入口)
libs/
或
packages/
:本地复用库(尤其多包项目)
docs/
:架构图、API 文档、README.md(非代码但属工作区一部分)
scripts/
:CI 脚本、本地工具(如数据生成、环境检查)
assets/
:图标、字体、模板等静态资源(避免混入
src/
) 不建议把
node_modules
、
__pycache__
、
build/
等生成物目录纳入工作区根目录——它们应被
.gitignore
排除,并在
.vscode/settings.json
中用
"files.exclude"
隐藏。 VS Code 专属配置:集中到
.vscode/
目录 所有编辑器级配置放在此目录下,保持根目录干净: php版微信js-sdk支付接口类 php版微信js-sdk支付接口类 下载
.vscode/settings.json
:工作区粒度设置(优先级高于用户设置)
.vscode/tasks.json
:自定义构建、测试、格式化命令
.vscode/launch.json
:调试配置(支持多环境:dev/staging)
.vscode/extensions.json
(可选):声明推荐扩展列表,方便新人一键安装 注意:
.vscode/
应提交到 Git(除非含敏感路径),确保团队环境一致。 语言与框架适配:按需补充约定 不同技术栈可微调结构,例如: Python :在
src/
下设
myproject/
包目录,加
pyproject.toml
;
.vscode/settings.json
中指定
python.defaultInterpreterPath
指向 venv TypeScript + React :
src/
外可加
public/
(静态资源)、
types/
(全局类型);启用
"typescript.preferences.includePackageJsonAutoImports": "auto"
多服务后端 :用多根工作区,每个服务一个
folders
条目,共用顶层
.code-workspace
统一调试/任务 基本上就这些。结构不是越深越好,关键是让新成员打开工作区后,30 秒内能定位入口、运行方式和关键配置位置。

相关文章