2025年互联网行业开发部程序员代码编写规范手册.docxVIP

2025年互联网行业开发部程序员代码编写规范手册

第1章代码结构与组织

1.1项目根目录规范

项目根目录必须严格遵循统一命名约定，所有文件、配置文件及构建脚本均直接置于`src`子目录中，严禁在`src`目录之外创建任何包含代码的文件。这不仅符合IDE自动补全机制的优化需求，也能有效防止因文件混排导致的编译时路径解析错误。根目录下应仅保留一个名为`package.json`的文件，该文件需明确指定项目的入口点（EntryPoint）——即`main.js`或`index.js`文件的路径，确保开发环境能自动识别并启动正确的程序入口。

在`package.json`中必须包含`scripts`字段，定义开发、构建及测试等核心命令，例如`npmrundev`启动开发服务器，`npmrunbuild`生产环境代码，`npmruntest`执行测试用例。根目录下的`.gitignore`文件需遵循行业最佳实践，明确忽略`node_modules`依赖包目录、`dist`输出目录、`.env`环境变量文件以及操作系统特有的编译产物（如`.exe`,`.dll`,`.so`等）。根目录下禁止存放`node_modules`文件夹，所有依赖库必须通过`npm`或`yarn`安装到项目根目录下的