软件行业技术部程序员代码编写规范手册（执行版）.docxVIP

软件行业技术部程序员代码编写规范手册（执行版）

第1章项目结构与目录规范

1.1根目录架构设计

根目录应严格遵循src作为主逻辑代码存放区，tests存放单元测试，docs存放文档，config存放配置文件，其余为辅助工具。禁止在根目录直接存放文件，所有项目文件必须通过子目录（如src/main/java,src/main/resources）进行组织，以确保编译器和IDE能准确识别包名。

根目录下需包含.gitignore文件，明确列出被版本控制系统（如Git）忽略的敏感信息，例如.env配置文件、本地缓存文件及构建产物。根目录应设置.gitattributes文件，针对不同文件类型定义编码格式（如java文件使用UTF-8），防止因编码不一致导致的编译报错。根目录需配置.editorconfig文件，统一设置编辑器配置（如缩进、格式化、Git提交设置），确保开发环境的一致性。

根目录应包含README.md文件，简要说明项目结构、安装步骤、构建命令及主要依赖，作为新加入团队成员的入门指南。

1.2子模块命名规则

子模块名称必须遵循包名.类名.类名的层级结构，采用小写字母加连字符分隔，避免使用特殊字符或空格。根目录下的子模块名称需与根目录下的包名（package）严格一致，例如若根目录包名为com.example.ap