软件行业技术部开发员代码编写规范手册.docxVIP

软件行业技术部开发员代码编写规范手册

第1章项目结构与代码组织

1.1项目根目录规范

项目根目录是软件工程的“指挥中心”，必须严格遵循以下六条规范以确保构建流程的自动化与可维护性：

根目录下严禁放置个人文件，仅允许存放`README.md`（项目说明）、`.gitignore`（构建排除规则）和`LICENSE`（开源协议）三个核心文件，任何`.pyc`、`.log`或`.env`等临时文件必须通过`.gitignore`明确排除。构建脚本（如`Makefile`或`CMakeLists.txt`）必须位于根目录，并作为执行入口，若需添加自定义脚本，必须将其置于`tools/`子目录中，且该目录必须放置在根目录的`tools`文件夹内，严禁直接放在根目录的`scripts`中。

所有文件必须遵循统一的命名前缀规范，例如Python项目前缀为`app`，Java项目前缀为`com.example`，C++项目前缀为`util`，且大小写必须严格遵循`snake_case`或`camelCase`约定，禁止使用`MyClass`或`class`等非规范命名。子模块之间必须建立清晰的层级关系，通过`subdir`或`src/app/modules`等目录结构实现隔离，禁止在根目录直接拼接模块名（如`