2025年软件行业研发部高级程序员代码质量规范手册.docxVIP

2025年软件行业研发部高级程序员代码质量规范手册

第1章编码基础与项目结构

1.1项目目录树规范与版本控制策略

项目根目录必须严格遵循语义化命名规范，所有子目录名称需以字母开头，仅允许包含字母、数字和下划线，禁止使用中文、空格或特殊字符，例如`src/com/company/project`而非`src/公司/项目`。核心业务代码必须位于`src`文件夹下，而`test`文件夹专门存放单元测试文件，确保开发环境下的`src`目录始终保持纯净，仅包含可编译的。

配置文件（如`pom.xml`或`build.gradle`）应置于`src/main/resources`目录中，避免与文件混杂，防止在编译时因配置冲突导致构建失败。文档与注释应放置在`src/main/docs`或`src/main/java/com/company/docs`目录，确保文档与代码逻辑分离，便于后续维护者快速定位业务逻辑说明。构建脚本（如`mvnw`或`gradlew`）应置于`src/main/resources/scripts`目录下，避免直接写在`pom.xml`或`build.gradle`中，防止因IDE配置或构建工具版本差异导致的构建错误。

日志文件必须放置在`src/main/logs`目录，严禁将日志写入`