软件开发行业技术部工程师代码编写规范.docxVIP

软件开发行业技术部工程师代码编写规范

第1章代码结构与组织

1.1项目根目录规范

项目根目录必须是绝对路径，严禁使用相对路径或模糊的`.`或`..`符号，确保所有脚本和文件路径在脚本执行时都能被解析。根目录下应包含`README.md`文档，它必须详细列出所有子目录的用途、禁止存放的文件类型以及项目的启动脚本路径。

根目录需设置`.gitignore`文件，明确列出IDE临时文件、操作系统缓存、操作系统特定配置（如Windows的`user.config`）以及本地测试数据，防止版本控制污染。根目录应包含`.prettierrc.js`或`.eslintrc.js`等配置文件，定义代码格式化（如Prettier）和代码风格检查（如ESLint）的严格标准，确保团队代码风格统一。根目录下禁止存放`.env`环境变量文件，所有敏感信息（如数据库密码、APIKey）必须通过环境变量注入或配置管理工具（如Jenkins变量）动态管理。

根目录下应包含`package.json`文件，明确列出项目的依赖包清单、脚本命令定义（如`npmrunbuild`）以及开发时的启动脚本（如`npmstart`）。

1.2模块划分与命名

模块划分应遵循单一职责原则，每个模块负责一个具体的业务功能或技术组件，避免模块间耦合