互联网行业研发部研发工程师代码编写规范手册.docxVIP

互联网行业研发部研发工程师代码编写规范手册

第1章

项目结构与代码组织规范

1.1项目根目录架构定义

项目根目录（ProjectRoot）作为所有代码、配置文件及构建工具的绝对起点，必须严格遵循语义化命名规范，避免使用`src`、`app`等易混淆的通用前缀，建议使用`main`、`core`或`app`等直观词汇，例如`src/main/java`或`src/main/python`。根目录下应包含`pom.xml`、`build.gradle`或`package.json`等构建入口文件，这些文件不仅定义了项目的依赖树，更是后续所有自动化构建任务（如Maven或Gradle）执行的唯一调度中心。

根目录需预设`config`、`logs`、`test`等独立子目录，这些目录在代码逻辑上应完全独立于业务代码，且必须配置好`log4j2.xml`、`perties`或`application.yml`等全局配置，确保环境差异不影响核心逻辑。根目录下的`README.md`或`CONTRIBUTING.md`文档至关重要，它应详细列出项目启动顺序、环境变量占位符说明以及推荐的IDE插件配置，为后续开发提供“开箱即用”的指南。根目录需明确标注`version`或`VERSION`常量，该常量需与Git