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

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

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

1.1项目根目录与版本控制

项目根目录（ProjectRootDirectory）是代码仓库的“大脑”，所有Git分支、提交记录及全局配置均在此处建立。它必须严格遵循项目初始化脚本的标准目录结构，严禁手动创建目录。根目录下需包含`.git`文件夹，其中存放着`.gitignore`文件，该文件定义了哪些文件不应被提交到版本控制中（如`.DS_Store`,`node_modules`等），确保版本库只保留核心业务代码。

根目录下的`README.md`或`README.zh-CN.md`文档是项目的“说明书”，必须清晰说明项目简介、技术栈列表、快速启动指南及贡献者指南，方便新成员快速上手。根目录下的`Makefile`或`CMakeLists.txt`是构建系统的入口，定义了编译命令、依赖安装脚本及构建产物（如`dist/`包）的流程，确保自动化构建的一致性。`.gitignore`文件内部需明确区分操作系统特定文件（如macOS的`.DS_Store`）和IDE特定文件（如VSCode的`.idea`配置），防止构建工具误删或还原配置。

根目录下的`.gitattributes`文件用于定义编码格式（如UTF-8）、换行符