2025年软件行业研发部程序员软件代码规范手册.docxVIP

2025年软件行业研发部程序员软件代码规范手册

第1章项目结构与组织

1.1项目根目录与核心配置文件

项目根目录（ProjectRootDirectory）是代码管理的绝对起点，所有、构建脚本及依赖文件必须严格位于该目录下，严禁跨目录存放。建议命名为`src`，其下包含两个子目录：`main`存放入口文件，`libs`存放外部依赖库。核心配置文件`package.json`必须定义项目的入口文件路径（如`src/index.js`）、开发依赖（devDependencies）和生产依赖（dependencies），并配置ESLint和Prettier的自动格式化规则，确保任何修改后无需手动调整代码风格。

`README.md`文件需作为项目的“说明书”，清晰阐述项目架构、技术栈版本、关键部署步骤及故障排查指南，方便新成员快速定位环境配置问题。根目录下的`.gitignore`文件必须精确排除Node运行时、编译产物、操作系统头文件及测试的临时文件，防止版本控制冲突及文件污染。`.eslintrc`配置文件需定义严格的代码风格标准，例如禁止使用`var`声明、禁止在`if`语句中使用动宾短语、禁止在对象字面量中混用`let/const`，并指定错误代码映射表。

`.prettierrc`文件需配置统一的缩进（2空格