2025年互联网行业技术部开发岗代码编写规范手册.docxVIP

2025年互联网行业技术部开发岗代码编写规范手册

第1章

项目结构与代码组织

1.1项目根目录规范

项目根目录（ProjectRootDirectory）是代码仓库的“总开关”，所有Git提交、CI/CD构建及团队协作都基于此进行。

根目录必须严格遵循`.gitignore`规则，确保非源码文件（如`node_modules`,`dist`,`logs`,`.log`,`npm-debug.log`）被自动忽略，防止版本控制污染。根目录需包含`package.json`,`tsconfig.json`,`README.md`等核心配置文件，这些文件定义了项目的运行时依赖、编译配置及文档说明，是开发者的第一入口。

根目录下应放置`Makefile`或`build.sh`等构建脚本，用于自动化执行`npminstall`,`tsc--build`等任务，避免手动执行命令。根目录需明确划分`src`,`test`,`docs`,`scripts`等子文件夹，其中`src`存放，`test`存放测试用例，`docs`存放文档，保持目录语义清晰。根目录应设置`.prettierrc`,`eslint.config.js`,`vitest.config.ts`等ESLint和Prettier配置