软件开发研发部程序员代码编写规范手册.docxVIP

软件开发研发部程序员代码编写规范手册

第1章

项目结构与文件组织

1.1根目录与顶层结构定义

根目录必须严格遵循标准目录树结构，禁止随意创建目录，确保所有项目文件位于`src/`目录下，这是代码仓库的基石。根目录下应包含`README.md`文件，其中必须清晰列出项目名称、版本号、主要维护人以及快速启动指南。

根目录需配置`.gitignore`文件，明确忽略操作系统特定文件（如`.DS_Store`）、IDE缓存及编译产物，保持Git仓库纯净。根目录应声明`package.json`或`pom.xml`等构建配置，记录开发环境依赖、测试脚本及自动化构