在mysql中可通过COMMENT为表和字段添加备注,创建表时使用COMMENT关键字可定义表描述,如“用户基本信息表”,字段定义时也可直接添加说明,如“主键,自增ID”,修改字段备注用ALTER table语句,查看备注可通过SHOW CREATE TABLE或查询information_schema,备注有助于团队协作、文档生成和避免字段用途混淆,例如订单状态字段可标注各数值含义。

在 MySQL 中,表格备注(即对表或字段的说明)可以通过 COMMENT 属性来实现。MySQL 支持为表和字段添加备注,便于团队协作和后期维护。
1. 为表添加备注
创建表时,使用 COMMENT 关键字为表添加描述:
CREATE TABLE user_info ( id int PRIMARY KEY AUTO_INCREMENT, name VARCHAR(50), email VARCHAR(100) ) COMMENT=’用户基本信息表,存储注册用户资料’;
查看表备注:
SHOW CREATE TABLE user_info;
或查询 information_schema:
select TABLE_COMMENT FROM information_schema.TABLES WHERE TABLE_SCHEMA = ‘your_database_name’ AND TABLE_NAME = ‘user_info’;
2. 为字段添加备注
在定义列时,直接使用 COMMENT 添加字段说明:
CREATE TABLE user_info ( id INT PRIMARY KEY AUTO_INCREMENT COMMENT ‘主键,自增ID’, name VARCHAR(50) COMMENT ‘用户姓名,最长50字符’, email VARCHAR(100) COMMENT ‘注册邮箱,唯一’ ) COMMENT=’用户基本信息表’;
修改已有字段备注:
ALTER TABLE user_info MODIFY column name VARCHAR(50) COMMENT ‘用户的姓名’;
查看字段备注:
SELECT COLUMN_NAME, COLUMN_COMMENT FROM information_schema.COLUMNS WHERE TABLE_SCHEMA = ‘your_database_name’ AND TABLE_NAME = ‘user_info’;
3. 实际应用场景
添加备注有助于:
- 新成员快速理解表结构
- 生成文档时自动提取说明
- 避免字段用途混淆,比如 status 字段值代表什么状态
示例:一个订单状态字段
status TINYINT default 0 COMMENT ‘订单状态:0-待支付,1-已支付,2-已发货,3-已完成,-1-已取消’ 基本上就这些。通过合理使用 COMMENT,可以让数据库更清晰易懂。


