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

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

第1章

项目结构与版本控制规范

1.1项目目录树与文件组织

必须严格遵循Root/ProjectName的顶层结构，确保所有代码文件位于根目录下的项目文件夹内，严禁在根目录直接放置未命名的脚本或测试文件，防止构建脚本误执行。子目录命名需遵循语义化原则，例如使用src存放，test存放单元测试，docs存放文档，且所有子文件夹名称必须使用小写字母、连字符和数字组合（如src/main/java），避免使用中文或特殊字符。

必须为每个模块创建独立的子目录，例如auth-service、payment-gateway或user-database，严禁在一个目录下混合不同业务逻辑的代码，以保持模块的边界清晰和可维护性。配置文件（如perties,Dockerfile,docker-compose.yml）必须放置在根目录下的特定子文件夹中，严禁与代码文件混排，同时确保配置文件中的敏感信息（如数据库密码、密钥）使用环境变量或密钥管理服务进行注入。建议采用扁平化目录结构（FlatStructure），即所有代码和配置集中在根目录下的不同子文件夹中，减少文件层级带来的导航困难，但需配合合理的子目录划分以平衡结构与性能。

每个子目录下必须包含一个README.md文件，简述该目录的业务功能、依赖库版本、关键部署步骤及开发注意