2025年软件行业技术部程序员代码规范维护手册.docxVIP

2025年软件行业技术部程序员代码规范维护手册

第1章项目结构与文件组织

1.1主项目目录规范

根目录必须严格遵循`root/`命名约定，所有顶层目录（如`src`,`tests`,`docs`）不得以`.`开头，且严禁包含`.git`等版本控制隐藏目录，这是项目启动后自动扫描识别核心架构的关键入口。每个顶层目录必须包含至少一个`.gitignore`配置文件，明确定义哪些文件（如`__pycache__`,`.env`,`.log`）应被忽略，确保Git仓库在初始化时自动排除非代码文件，防止混淆。

目录结构需体现模块化设计原则，例如`src/main/java`或`src/main/python`中必须存在`main.py`或`main.go`入口文件，作为程序启动的唯一逻辑锚点，保证运行时路径解析的确定性。代码文件命名必须严格遵循`lowercase-with-dashes`命名风格（如`user-service.py`），禁止使用全大写字母、连字符、下划线或特殊字符，以统一IDE自动补全和静态分析工具的识别逻辑。所有文件必须位于`src`目录下，严禁将`.pyc`、`.pyo`编译缓存文件直接放入源码目录，这些文件仅在运行时，不应作为版本控制对象，保持源码纯净。

根目录下的`README.