软件行业开发部开发工程师前端开发规范手册.docxVIP

软件行业开发部开发工程师前端开发规范手册

第1章项目结构与代码组织

1.1目录规范与根目录结构

在软件开发的基石上，清晰的目录结构是团队协作的“地图”，它决定了代码的可维护性与扩展性，避免“大海捞针”式的查找困难。根目录不应包含具体的业务逻辑文件，而是作为所有文件的“总开关”。

根目录必须严格遵循约定规范，禁止直接存放`.js`、`.ts`或`.jsx`等文件，所有业务代码必须位于`src`目录下，通过`import`语句从根目录导入，确保入口文件统一且无歧义。根目录下应配置`package.json`文件，明确列出项目的`name`、`version`及`main`字段，这是后续构建工具（如Vite、Webpack）识别项目身份的核心依据，也是版本管理的起点。

根目录下需建立`.gitignore`文件，以排除Node.js运行时环境（如`node_modules`）、编译产物（如`dist`、`.babelrc`）、操作系统特有文件（如`Dockerfile`）以及测试配置文件，防止仓库污染。根目录下的`README.md`必须包含项目简介、快速开始指南、依赖列表及构建命令，作为新成员进入项目的第一道门槛，降低环境配置的门槛。根目录应设置`.gitattributes`文件，明确指定`.gitignore`