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

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

第1章

项目结构与代码组织

1.1根目录规划与核心文件定位

根目录必须严格遵循Project命名规范，作为整个开发项目的唯一入口，严禁直接在此目录存放配置文件或中间产物。根目录下需建立包含`src`、`tests`、`docs`、`config`及`scripts`六个子目录，每个子目录代表一个功能模块或用途类型，确保目录层级清晰。

所有文件必须位于`src`目录下，而配置文件（如`package.json`或`pom.xml`）则必须位于根目录下的`config`子目录中，以区分代码与配置。在`src`目录下进一步细分为`components`、`services`、`utils`等子文件夹，分别对应UI组件、业务逻辑服务及通用工具类，实现模块化分层。每个子文件夹下必须包含`.gitignore`文件，明确列出该文件夹内不应被版本控制的文件，如`node_modules`、`.env`及临时的日志文件。

根目录下的`README.md`文档需简要说明项目架构、主要模块职责及快速开始指南，为后续开发提供宏观指引。

1.2代码命名规范与类型定义

所有类名、接口名及常量名必须使用驼峰命名法（CamelCase），且首字母必须大写，例如`User`而非`user`，以符合Ja