软件开发行业研发部开发工程师代码编写规范手册.docxVIP

软件开发行业研发部开发工程师代码编写规范手册

第1章项目结构与文件组织

1.1项目根目录架构规范

本项目采用模块化分层架构设计，旨在通过清晰的目录层级实现代码的隔离、复用与协作。根目录（RootDirectory）作为项目的“宪法”，需严格遵循以下结构：根目录下必须建立名为`docs`的子目录，存放项目说明文档、API接口文档及架构设计说明书，确保项目文档与代码分离；建立`src`主目录，该目录必须按模块划分，例如`src/web`、`src/worker`或`src/service`，每个模块独立存放对应业务逻辑；第三，在模块内部设立`config`、`utils`、`models`及`api`子目录，分别集中管理全局配置、工具函数、数据模型及外部接口定义，避免代码污染；第四，建立`tests`目录存放单元测试文件，遵循`test/`前缀命名规范，确保测试代码与业务代码物理隔离；第五，设立`scripts`目录存放自动化测试脚本、构建命令及CI/CD配置，便于执行管线自动化运行；第六，根目录必须包含`.gitignore`文件，明确列出编译产物、日志文件、操作系统缓存及敏感信息（如密钥、密码）的排除规则，保障版本控制安全。

根目录结构示意如下：`src/web/`下包含`models/user.js`、`api/user