# isc-data-factory

**Repository Path**: jfld/isc-data-factory

## Basic Information

- **Project Name**: isc-data-factory
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-02-28
- **Last Updated**: 2024-02-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 编码规范

**大体**遵循阿里规范，但是需要着重强调以下几点：

- 关于注释

  大多数情况下，我们不强求写注释，更加推荐代码即注释的约定，但是前提是编码、命名等相对规范，即使满足了代码即规范的约定了，我们也需要在以下情况下写注释：

    1. 方法体中，分支逻辑较多，需要对应分支逻辑给出注释
    2. 方法逻辑复杂，需留下较为详细的代码，或者大体思路

- 关于命名

  严格遵循驼峰式命名，避免简写，命名准确

- 关于编码

    1. 避免大方法，尽量对方法进行抽象，从而避免方法体过长，分支过多导致他人理解困难
    2. 异常处理严谨，特别是随处可见的`NPE`
    3. 合理命名，如`DTO`、`Form`等等
    4. **统一返回结构**，具体参见代码

  部分内容可以参考https://isyscore.yuque.com/device.team/fifp6y/idadk7

# 分支规范

采用相对规范的`gitflow`分支管理

具体内容参考https://isyscore.yuque.com/device.team/fifp6y/rfl3cw