Standards

HiveNetCore

• 错误码规范
  • 错误码定义原则
    • 唯一性原则
    • 无歧义原则
    • 细粒度原则
  • 错误码定义
  • 错误明细编码统一管理
  • API（网络接口）错误码要求
    • 系统标识及模块标识应用指引
  • 系统内部方法（函数）错误码要求
    • 应用错误码的场景
    • 错误码应用要求
    • 模块错误定位(扩展)
  • 附表-HiveNet错误明细编码清单
    • 成功错误编码（0000 - 0099）
    • 用户行为错误编码（0100 - 0399）
    • 网络通讯错误编码（0400-0599）
    • 数据库错误编码（0600-0799）
    • 操作系统错误编码（0800-0999）
    • 函数调用错误编码（1000-1399）
    • 应用服务错误编码（1400-1599）
    • 业务错误编码（3000-4999）

HiveNetWebUtils

• 日志规范
  • 文件存放路径
  • 文件命名
  • 日志输出规范
    • 标准格式
    • 应用启停日志规范
      • 应用启动日志
      • 应用关闭日志
    • 操作审计日志规范
    • 交易日志规范
    • 接口日志规范
      • 发送方日志
      • 接收方日志
    • 函数调用链日志规范
      • 函数调用开始日志
      • 函数调用结束日志
    • 接口调用链日志规范
    • 异常日志规范
• Python代码规范
  • 代码风格规范
    • 分号
    • 行长度
    • 括号
    • 缩进
    • 空行
    • 空格
    • 导入格式
    • 字符串
    • 类
  • 命名规范
  • 注释规范
    • 块注释和行注释
    • TODO注释
    • FIXME注释
  • Docstring规范
    • Python类型
    • @typedef
    • 公共选填标签
    • 模块（Module）注释
    • 类注释
    • 函数注释
    • 属性注释
    • 枚举注释
  • 编码规范
    • 字符串指定编码
    • 文件（*.py）开头
    • Main脚本执行
    • 模块信息
  • 高阶编码技巧 （非规范）
    • 函数入参默认值初始化
    • 异常处理
    • 文件和sockets
    • with…as的用法
    • 使用contextlib支持with
    • 灵活使用yield降低内存消耗