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

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

第1章

项目结构与代码组织

1.1通用目录规范

项目根目录结构必须严格遵循Top-Level-Project模式，禁止在根目录直接存放文件。根目录下仅保留配置文件（如`package.json`）、构建脚本（如`Makefile`或`CMakeLists.txt`）及单元测试配置文件（如`jest.config.js`或`setup.py`），确保所有业务代码均位于子目录中。每个子目录必须包含一个以`__init__.py`或`__init__.js`文件明确标识其为Python或JavaScript模块，防止Python解释器将其视为包而非模块，从而避免导入报错。

所有文件必须以`.py`（Python）、`.js`（JavaScript）、`.ts`（TypeScript）或`.java`（Java）为扩展名，严禁使用`.pyc`、`.pyo`、`.js.map`等编译后文件或中间文件作为目录。目录命名需遵循语义化原则，避免使用纯数字或下划线分隔符（如`123.py`或`my_module_123.py`），推荐使用小写字母、连字符和驼峰命名法（如`user_profile_api.py`）。子目录名称应遵循统一命名规范，通常使用单数形式且首字母大写（如`api`、`uti