软件开发行业技术部程序员代码规范编写手册.docxVIP

软件开发行业技术部程序员代码规范编写手册

第1章

项目结构与代码组织

1.1项目根目录规范与目录树构建

定义根目录为所有、配置文件及构建输出的唯一入口，严禁在根目录直接存放二进制文件或临时脚本。建立标准的目录树结构，例如：`/src/`存放，`/test/`存放单元测试，`/docs/`存放技术文档，`/assets/`存放静态资源。

规定所有子目录必须包含`README.md`文件，该文件需简述该目录下代码的功能模块、依赖库版本及构建命令。强制要求目录命名遵循语义化规则，如`src/user-service/`代表用户服务模块，`lib/utils/`代表通用工具库，避免使用`module1/`等无意义名称。规范文件扩展名，Java类文件统一为`.java`，配置文件统一为`.yaml`或`.yml`，脚本文件统一为`.sh`或`.py`，严禁混用或随意更改。

设立`.gitignore`文件，明确列出操作系统缓存、编译产物、日志文件及IDE临时文件，确保开发环境自动忽略。

1.2模块划分策略与命名约定

依据业务领域划分模块，将大项目拆分为独立的服务单元，每个模块负责一个核心业务闭环，如“订单服务”、“支付服务”、“库存服务”。模块内部采用单一职责原则，禁止在一个类或文件中实现超过三个逻辑功能，防止代码耦合度过