如何给字段添加注释说明_Comments属性配置指南-phpMyAdmin-PHP中文网

sql server需用sp_addextendedproperty配合sys.extended_properties添加字段注释，postgresql支持comment on column，mysql 8.0+仅能在alter table modify column时补注释，orm注释落地依赖方言实现与权限。

sql server 里怎么给字段加注释（`sys.extended_properties`）

sql server 不支持 comment on column 这种标准语法，得靠系统视图 sys.extended_properties 手动加。直接用 sp_addextendedproperty 最稳，但必须指定对象层级（表、列）、schema 名，漏一个就查不到。

先确认目标字段存在：SELECT * FROM sys.columns WHERE name = 'status' AND object_id = OBJECT_ID('dbo.orders')

执行添加（注意引号嵌套和 schema）：

EXEC sp_addextendedproperty 
  @name = N'MS_Description', 
  @value = N'订单当前状态：0-待支付，1-已发货，2-已完成', 
  @level0type = N'SCHEMA', @level0name = N'dbo',
  @level1type = N'TABLE',  @level1name = N'orders',
  @level2type = N'COLUMN', @level2name = N'status';

重复执行会报错 The property cannot be added because it already exists，改用 sp_updateextendedproperty 覆盖，或先删后加

PostgreSQL 怎么用 `COMMENT ON COLUMN` 加字段说明

PostgreSQL 原生支持，语法简洁，但要注意单引号转义和权限问题——执行用户必须是表 owner 或有 ALTER 权限。

基本写法：COMMENT ON COLUMN public.users.email IS '用户注册邮箱，唯一且非空';
中文注释没问题，但若 SQL 客户端编码不对（比如 pgAdmin 用 GBK 连 UTF8 数据库），可能存成乱码，统一用 UTF8 连接
注释内容不能含未转义的单引号，否则报错 syntax error at or near "s"；写成 IS '用户''的手机号'（两个单引号）
注释不参与查询优化，也不影响索引，纯属元数据，导出结构时默认不带，需加 --inserts 或 --clean 参数才保留

MySQL 8.0+ 字段注释只能靠 `COMMENT` 子句，建表后没法单独加

MySQL 的字段注释只能在 CREATE TABLE 或 ALTER TABLE ... MODIFY COLUMN 时声明，没有独立的 COMMENT ON 语句。想补加？只能改字段定义，哪怕只是重申类型。

新建表时写法：score TINYINT COMMENT '0-100 分制，-1 表示缺考'
已有表补注释：ALTER TABLE exam_results MODIFY COLUMN score TINYINT COMMENT '0-100 分制，-1 表示缺考';
如果只改注释、不改类型，仍要重复写一遍原类型，否则会隐式变成 DEFAULT NULL，导致非空约束丢失
SHOW CREATE TABLE 能看到注释，但 INFORMATION_SCHEMA.COLUMNS 里字段是 COLUMN_COMMENT，别拼错

ORM 框架里写注释容易被忽略的兼容点

很多 ORM（如 Django、SQLAlchemy）支持字段级 comment 参数，但生成 DDL 时是否真落地，取决于方言实现和版本。不是写了就一定进数据库。

Django 4.2+ 的 models.CharField(comment='...') 只对 PostgreSQL / MySQL 8.0+ 生效，SQL Server 需额外配 db_comment 并启用 django-mssql 扩展
SQLAlchemy 的 Column(..., comment='...') 在 create_all() 时才写入，但 Alembic 迁移默认不包含注释变更，得手动加 op.alter_column(..., comment='...')
所有框架生成的注释都绕不开底层 SQL 权限限制——如果应用账号没 ALTER 或 EXECUTE 权，注释就静默失败，日志里可能只有一行 warning

字段注释这事，看着是加个字符串，实际卡点全在权限、方言差异和执行时机上。最常出问题的是：以为 ORM 写了就进了库，结果查 pg_description 或 sys.extended_properties 发现空着；或者 MySQL 改注释时忘了重写字段类型，把 NOT NULL 给弄丢了。