---
title: "注释的使用 - OceanBase 数据库 V4.3.4 | OceanBase 文档中心"
description: 注释的使用 表注释的使用 给表的每个字段加上注释，有助于更好的通过建表语句理解表及其各个字段所起到的作用，有助于后续开发人员共同开发，是对数据库设计文档的一个有利的补充，是一个天然的功能说明。 表加注释有 2 种方式。 在创建表的同时加注释。 obclient> CREATE TABLE student( id IN…
---
切换语言

- 中文站 - 简体中文
- International - English
- 日本站 - 日本語

文档反馈![](https://mdn.alipayobjects.com/huamei_22khvb/afts/img/A*P8CuR4UJ_FkAAAAAAAAAAAAADiGDAQ/original) OceanBase 数据库分布式版 - V 4.3.4

# 注释的使用

更新时间：2024-12-12 23:00:00

[编辑](https://github.com/oceanbase/oceanbase-doc/edit/V4.3.4/zh-CN/700.reference/400.database-design-specifications-and-practices/500.use-of-table-notes.md)  

## 表注释的使用

给表的每个字段加上注释，有助于更好的通过建表语句理解表及其各个字段所起到的作用，有助于后续开发人员共同开发，是对数据库设计文档的一个有利的补充，是一个天然的功能说明。

表加注释有 2 种方式。

- 在创建表的同时加注释。

  ```sql
  obclient> CREATE TABLE student(
  id INT PRIMARY KEY AUTO_INCREMENT COMMENT '学号',
  name VARCHAR(200) COMMENT '姓名',
  age INT COMMENT '年龄') COMMENT='学生信息';

  ```
 - 创建表后，使用 `alter` 语句加注释。

  ```sql
  obclient> CREATE TABLE student( id INT PRIMARY KEY AUTO_INCREMENT , name VARCHAR(200) , age INT);
  obclient> ALTER TABLE student COMMENT '学生信息';
  obclient> ALTER TABLE student MODIFY COLUMN id INT COMMENT '学号';
  obclient> ALTER TABLE student MODIFY COLUMN name VARCHAR(200) COMMENT '姓名';
  obclient> ALTER TABLE student MODIFY COLUMN age INT COMMENT '年龄';

  ```

  这里推荐第二种在创建表之后，使用 `ALTER` 语句加注释，便于后续对表进行维护。

## SQL 语句注释的使用

对于普通 SQL 语句，OceanBase 数据库支持以下三种注释方法：

- 从 `#` 到行尾，可以注释一行。
 - 从 `--` 到行尾，可以注释一行。
 - 从 `/*` 到 `*/`，可以注释多行。

  #### 说明

  SQL 语句不支持嵌套注释。

特别地，OceanBase 数据库支持将 `/*！*/` 内部的语句当成 SQL 处理并执行注释中的语句。如果 `/*！*/` 里出现语法错误，数据库会默认当作注释处理。

注释的格式如下：

```sql
/*![表示版本号的连续数字字符]<空格><任意 SQL 语句 >*/

```

示例：

- 为表 `t1` 创建 Hash 分区，分区数为 `8`。

  ```sql
  obclient> CREATE TABLE t1 (c1 INT PRIMARY KEY, c2 INT) /*!50100
      PARTITION BY HASH(c1) PARTITIONS 8*/;
  Query OK, 0 rows affected

  ```
 - 使用 `ENABLE KEYS` 更新非唯一索引，批量插入的时候可以使用 `DISABLE KEYS` 先不更新，所有索引插入完之后再更新索引。

  ```sql
  obclient> /*!ALTER TABLE t1 DISABLE KEYS */;
  Query OK, 0 rows affected

  obclient> /*!ALTER TABLE t1 ENABLE KEYS */;
  Query OK, 0 rows affected

  ```
 - 支持执行 PL 的 `DROP IF EXISTS` 语法。

  ```sql
  obclient> /*!50003 DROP PROCEDURE IF EXISTS */;
  Query OK, 0 rows affected

  ```

 上一篇 下一篇 ![有帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*y6ocSqN8cqsAAAAAAAAAAAAAARQnAQ)![无帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*BG9IQJyLHF8AAAAAAAAAAAAAARQnAQ)![反馈](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*eTWdQKCRKHwAAAAAAAAAAAAAARQnAQ)[AI](https://www.oceanbase.com/obi) 咨询热线