数据仓库:注释规范

数据仓库:注释规范

  • 所有字段必须有注释,注释要简洁明确
  • 字段注释的格式
    • 枚举类字段:
      • 字段描述:值1-说明1,值2-说明2(详细说明),...
      • 如 订单状态:0-有效,1-无效(24h未支付订单置为无效)
    • 金额类字段:
      • 字段描述:单位(RMB)
      • 如 付费金额:单位元(RMB)
    • 外键类字段:
      • 字段描述:[被参照表.]被参照字段
      • 如 用户ID:zhs_user.user_id
    • 废弃类字段:
      • 已废弃[:请参考新表.新字段]
      • 如 已废弃:请参考zhs_pgc_shool_payment.pay_status
    • boolean类型字段
      • 字段描述
      • 如 是否毕业
  • 分隔符统一使用中文字符

你可能感兴趣的:(数据仓库:注释规范)