- 0
- 0
- 约3.25万字
- 约 44页
- 2026-05-15 发布于江西
- 举报
软件行业研发中心程序员软件编码开发手册(执行版)
第1章项目结构与代码规范
1.1项目根目录组织原则
根目录下严禁存放任何非版本控制系统的文件,包括文档、配置文件(.conf,.ini,.env等)、项目说明文件(README.md)以及临时的日志文件。所有代码、测试数据和配置文件必须严格置于Git仓库根目录(.git文件夹)内,确保版本控制系统的完整性。必须建立清晰的子目录层级结构,遵循“功能模块化”原则,每个功能模块独立成目录,目录名应使用大写字母开头并下划线分隔(如`src/main/java/com/example/module`),避免使用中文作为目录名,防止编码冲突。
项目根目录下的`.gitignore`文件是代码管理的关键防线,它应明确列出操作系统默认忽略的敏感信息(如`.DS_Store`,`Thumbs.db`)、开发环境临时文件(如`.tmp`,`.bak`)以及本地资源文件,防止误提交到版本库。配置文件应放置在根目录下的特定配置文件夹中(如`src/main/resources/config`或`config`目录),并严禁直接写在文件中,除非该配置是绝对必要的且必须通过环境变量注入,以避免代码逻辑混淆。依赖管理必须通过`pom.xml`(Maven)或`build.gradle`(Gradle)
原创力文档

文档评论(0)