第 9.1 节:添加注释

有三种类型的注释:

  • 从 # 开始,持续到行尾
  • 从 -- 开始,持续到行尾(注意 -- 后必须跟一个空格)
  • 从 /* 开始,到 */ 结束,可跨多行

示例:

SELECT * FROM t1;   -- 这是注释
CREATE TABLE stack (
    /* id_user int,
    username varchar(30),
    password varchar(30) */
    id INT
);

-- 方法要求在注释开始前,-- 后面必须跟一个空格,否则它将被解释为命令并通常导致错误。

/* 这个注释有效 */
/* 这个注释也有效。*/
-- 这个注释无效。

第 9.2 节:注释表定义

CREATE TABLE menagerie.bird (
    bird_id INT NOT NULL AUTO_INCREMENT,
    species VARCHAR(300) DEFAULT NULL COMMENT '你可以包含属名,但不要包含亚种。',
    INDEX idx_species (species) COMMENT '我们必须经常按物种搜索。',
    PRIMARY KEY (bird_id)
) ENGINE = InnoDB COMMENT '此表于 2 月 10 日启用。';

在 COMMENT 后使用 = 是可选的(官方文档)。

这些注释与其他注释不同,它们会与模式一起保存,并可以通过 SHOW CREATE TABLE 或从 information_schema 中检索。