软件行业IT部程序员代码编写规范手册.docxVIP

软件行业IT部程序员代码编写规范手册

第1章项目结构与文件组织

1.1项目根目录规范

项目根目录是软件工程的“地基”，它决定了整个代码库的边界、协作效率以及维护的便捷性。作为所有开发人员的共同起点，这里必须严格遵循以下规范。

根目录应仅包含核心配置文件（如`package.json`或`pom.xml`）以及一个名为`src`的子目录，严禁在此目录直接存放`.gitignore`以外的任何代码文件，以确保初始版本控制状态清晰。根目录下必须存在一个名为`.gitignore`的文件，其中需明确列出`node_modules`、`dist`、`.env`及本地测试数据等目录，防止这些非文件被版本控制，保护代码库的纯净性。

根目录的`.gitignore`内容应基于项目实际依赖进行调整，例如若使用`npm`管理依赖，则需添加`node_modules/`，若使用`maven`则需添加`target/`和`pom.xml`的相关忽略规则，确保忽略策略与构建工具完全匹配。根目录下禁止存放任何`.idea`、`.vscode`或`.swp`等IDE或编辑器临时文件，这些文件由编辑器自动管理，不应纳入Git版本控制范围，避免代码同步冲突。根目录的`package.json`（或`pom.xml`）必须包含`n