软件行业开发部开发工程师代码审查规范手册.docxVIP

软件行业开发部开发工程师代码审查规范手册

第1章代码结构与组织

1.1项目目录规范与文件命名规则

所有文件必须遵循统一的命名约定，采用小写、连字符分隔的格式（如`module-name.ts`），严禁使用大写开头或特殊字符，以确保开发环境下的可识别性与自动化构建工具的解析能力。根目录下必须建立`src`目录存放所有业务代码，`src`内部再按功能划分子目录（如`api`、`utils`、`config`），严禁将测试代码、文档或配置文件直接混入主代码目录，保持代码目录的纯粹性。

配置文件（如`package.json`、`tsconfig.json`、`vite.config.ts`）必须放置在`root`目录下，严禁使用`node_modules/.bin`等被系统自动加载的路径，防止构建工具误读系统命令导致构建失败。依赖包目录必须严格位于`node_modules`下，且版本号必须通过`package-lock.json`锁定，禁止在`node_modules`目录下手动创建子文件夹来存放临时依赖，以保障依赖管理的规范性。单元测试文件必须放置在`test`目录下，且文件名后缀严格为`.test.ts`或`.test.js`，文件名中不得包含空格或特殊字符，确保测试脚本能直接被Jest或Vitest等测试框架识别