首页/数据/数仓建模速查/注释规范:表与字段必须写注释
分层与规范64 条

注释规范:表与字段必须写注释

建表必须写表注释与字段注释,注释写业务含义与口径,不写「字段1」这类占位;注释是元数据采集与检索的基础。

数仓建模速查数据更新于 2026-10-12
表注释业务含义+粒度
字段注释含义+单位
禁止占位注释
用途元数据检索

注释示例

注释示例
CREATE TABLE dws_trade_store_day (
  store_id  STRING COMMENT '门店ID,来源 dim_store.store_id',
  order_cnt BIGINT COMMENT '支付订单数,剔除去重后的唯一订单',
  pay_amt   DECIMAL(18,2) COMMENT '支付金额,单位元'
) COMMENT '交易主题-门店粒度-日汇总;负责人:data-zhang';
注释缺失率可以做数据资产巡检指标,纳入建模评审清单。

易错点

  • 注释与实现不一致,注释比没有注释更误导

数据来源与参考

  • 阿里《大数据之路:阿里巴巴大数据实践》
​‌‌​​‌​​​‌‌​‌‌‌‌​‌‌​​​‌‌​‌‌‌​​‌‌​​‌​‌‌‌​​‌‌‌​​​‌​‌‌​‌​​‌​‌‌‌​​​‌​‌‌​‌​​‌​‌‌​​​‌‌​‌‌‌​‌​​​‌‌​‌‌‌‌​​‌​‌‌‌​​‌‌​​​‌‌​‌‌​‌‌‌‌​‌‌​‌‌​‌