计算机行业软件部软件工程师代码编写规范手册.docxVIP

计算机行业软件部软件工程师代码编写规范手册

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

1.1根目录文件结构规范

根目录下必须严格保留一个名为`README.md`的文档，该文档需作为项目的“宪法”，首先介绍项目背景、技术栈选型、核心依赖库版本（如`npm9.6.7`）及构建脚本路径，确保所有新入职工程师在接入项目时能瞬间掌握全局信息。根目录下需建立统一的`.gitignore`文件，通过正则表达式精确匹配并忽略非代码文件，例如排除`node_modules`包依赖、`dist`编译产物、`coverage`测试报告以及操作系统特有的配置文件（如`cmake`的`build/