金融行业科技部开发人员代码审查规范手册.docxVIP

金融行业科技部开发人员代码审查规范手册

第1章代码结构与组织

1.1项目目录规范

根目录下应严格划分出`src`,`tests`,`docs`,`config`,`scripts`,`logs`,`bin`等核心子目录，严禁将个人文件、临时文件或无关文档混入项目根目录，确保项目结构清晰且符合团队约定。所有文件必须遵循统一的命名规则，例如采用`模块名_功能描述_版本号_语言扩展名`的格式（如`user_manager_v1.2.py`），禁止使用`test.py`等通用后缀，以区分测试代码与生产代码。

目录层级结构应自顶向下逐层细化，避免在同一目录下放置过多无关文件，确保从根目录到具体文件路径的导航路径不超过3-4层，提升代码的可维护性和检索效率。配置文件（如`application.yml`,`docker-compose.yml`,`perties`）必须集中放置在根目录下的`config`子目录中，且严禁直接嵌入在Python代码文件内部，防止因版本冲突导致运行时环境不一致。日志目录（`logs`）应独立于项目根目录，并建议设置按日期自动归档的机制，保留最近7天的日志文件，超过30天的历史日志可归档至对象存储或远程服务器，避免磁盘空间被长期占用。

构建脚本（如`Makefile`,`Dockerfile