comment-syntax.md

title	category	aliases
注释语法	reference	/docs-cn/dev/reference/sql/language-structure/comment-syntax/

注释语法

TiDB 支持三种注释风格：

• 用 # 注释一行
• 用 -- 注释一行，用 -- 注释必须要在其之后留出至少一个空格。
• 用 /* */ 注释一块，可以注释多行。

例：

{{< copyable "sql" >}}

SELECT 1+1;     # 注释文字

+------+
| 1+1  |
+------+
|    2 |
+------+
1 row in set (0.00 sec)

{{< copyable "sql" >}}

SELECT 1+1;     -- 注释文字

+------+
| 1+1  |
+------+
|    2 |
+------+
1 row in set (0.00 sec)

{{< copyable "sql" >}}

SELECT 1 /* 这是行内注释文字 */ + 1;

+--------+
| 1  + 1 |
+--------+
|      2 |
+--------+
1 row in set (0.01 sec)

{{< copyable "sql" >}}

SELECT 1+
    -> /*
   /*> 这是一条
   /*> 多行注释
   /*> */
    -> 1;

+-------+
| 1+

1 |
+-------+
|     2 |
+-------+
1 row in set (0.00 sec)

{{< copyable "sql" >}}

SELECT 1+1--1;

+--------+
| 1+1--1 |
+--------+
|      3 |
+--------+
1 row in set (0.01 sec)

TiDB 也跟 MySQL 保持一致，支持一种 C 风格注释的变体：

/*! Specific code */

在这种格式中，TiDB 会执行注释中的语句，这个语法是为了让这些 SQL 在其他的数据库中被忽略，而在 TiDB 中被执行。

例如：SELECT /*! STRAIGHT_JOIN */ col1 FROM table1,table2 WHERE ...

在 TiDB 中，这种写法等价于 SELECT STRAIGHT_JOIN col1 FROM table1,table2 WHERE ...

如果注释中指定了 Server 版本号，例如 /*!50110 KEY_BLOCK_SIZE=1024 */，在 MySQL 中表示只有 MySQL 的版本大于等于 5.1.10 才会处理这个 comment 中的内容。但是在 TiDB 中，这个 MySQL 版本号不会起作用，所有的 comment 都被会处理。TiDB 有自己的版本号注释语法，格式为 /*T!30100 XXX */。

还有一种注释会被当做是优化器 Hint 特殊对待：

{{< copyable "sql" >}}

SELECT /*+ hint */ FROM ...;

由于 hint 包含在类似 /*+ xxx */ 的 comment 里，MySQL 客户端在 5.7.7 之前，会默认把 comment 清除掉，如果需要在旧的客户端使用 hint，需要在启动客户端时加上 --comments 选项，例如 mysql -h 127.0.0.1 -P 4000 -uroot --comments

TiDB 支持的相关优化器 hint 详见 Optimizer Hints。

更多细节。