信息技术行业研发部程序员代码编写规范手册.docxVIP

信息技术行业研发部程序员代码编写规范手册

第1章代码结构与组织

1.1项目目录规范

根目录下应严格禁止直接存放`.py`、`.js`、`.java`等文件，所有项目根目录必须包含`src`、`tests`、`tests`、`docs`、`tests`、`bin`、`config`、`data`、`scripts`、`utils`、`models`、`api`、`config`、`logs`等标准子目录，以体现清晰的项目架构。每个子目录必须遵循统一的命名约定，例如`src`目录下的代码文件必须以`snake_case`（下划线分隔）命名（如`user_service.py`），而测试文件则必须使用`test_`前缀（如`test_user_service.py`），以区分开发与测试代码。

根目录下的`README.md`文件必须包含项目简介、快速开始指南、依赖列表、构建脚本说明以及核心开发者的联系方式，确保新成员能在3分钟内完成环境搭建。在`config`目录下，所有配置文件（如`config.py`或`application.yml`）必须使用`YAML`或`JSON`格式编写，严禁使用`INI`格式，且配置项名称必须与代码中的变量名保持一致，便于自动化配置管理。根目录下的`.gitignore`文件必须精确