金融行业科技部开发工程师软件开发编码手册.docxVIP

金融行业科技部开发工程师软件开发编码手册

第1章项目结构与版本管理

1.1项目根目录规范与目录结构

在金融科技的开发环境中，清晰且标准化的目录结构是团队协作的基石，它直接决定了代码的可维护性、部署效率以及故障排查的便捷性。一个规范化的根目录不仅便于新人快速上手，还能有效防止因文件混排导致的逻辑错误。

核心代码与资源分离：根目录下应严格划分为`src`（）、`tests`（单元测试）、`docs`（文档）和`utils`（工具类）四个层级，确保生产代码、测试代码和辅助工具互不干扰。配置与构建脚本独立：`.gitignore`文件需明确排除`node_modules`,`.env`,`dist`,`.idea`等敏感或构建产物目录，防止版本控制中包含非代码资产。

版本控制根目录：`.git`仓库根目录应仅保留`README.md`（项目说明）、`package.json`（依赖管理）、`tsconfig.json`（构建配置）及`.gitignore`等元数据文件。模块命名约定：子目录名称应采用小写字母加连字符命名（如`src/modules/finance-core`），避免使用中文或空格，保持目录层级扁平化，利于文件浏览。常量与枚举集中管理：将业务常量、枚举值、配置类统一提取到`src/constants`或`src/config`