软件行业研发部程序员代码编写维护手册.docxVIP

软件行业研发部程序员代码编写维护手册

第1章项目结构与代码组织

1.1项目根目录架构规范

项目根目录（ProjectRoot）应严格遵循统一的目录结构模板，所有文件必须位于`src/main/java`或`src/main/python`等指定子目录下，严禁直接放置在`src`根目录或`src/main`根目录下，以确保IDE自动补全功能正常及构建系统识别准确。根目录下的`pom.xml`（Maven）或`build.gradle`（Gradle）文件必须配置完整的依赖管理，包括项目级依赖、测试依赖以及开发依赖（devDependencies），且版本号需严格锁定在发布版本，禁止使用`x.y`这种开发版本。

每个模块（Module）需独立定义`pom.xml`或`build.gradle`文件，明确声明模块内的依赖关系，例如将SpringBoot依赖置于`pom.xml`的`dependencies`标签中，并配置`groupId`和`artifactId`以匹配父项目的模块名。根目录下的`README.md`文档必须包含清晰的“快速开始”指南，列出所有必需的环境配置步骤（如JDK版本、Maven版本、数据库连接信息），并附上构建完整项目所需的命令行指令。根目录下的`.gitignore`文