Source: https://dev-docs.yueshu.com.cn/v5.3.2/database-gql-reference/overview/comment/
Documentation version: v5.3.2

# 注释

注释用于为 GQL 语句或代码片段添加解释性说明或备注。注释会被解释器忽略，不会影响执行逻辑。

GQL 支持两种注释类型：

- 简单注释（单行注释）

- 块注释（多行注释）

本文介绍两种注释的使用方法。

## 简单注释

简单注释用于在单行上添加解释性文本或备注。注释以`//`或`--`开头，延续至行尾。

### 语法规则

- 符号：`//`或`--`
- 作用范围：从起始符号开始到行尾。简单注释仅用于单行。要在多行中添加注释，每行重复使用注释符号或改用块注释。
- 位置：可独立成行，或置于语句末尾。

### 示例

以下示例仅用于演示注释的位置和写法，不限定具体产品中的执行入口。

````
'''
// 示例：独立成行的简单注释
-- 说明下一条语句的用途
statement_1
statement_2    -- 说明该语句的作用。
'''           

````

## 块注释

块注释用于为单行或多行语句添加解释性文本。注释以`/*`开始，以`*/`结束，支持跨行。

### 语法规则

- 符号：`/*`和`*/`
- 作用范围：从开始符号到结束符号之间的内容。
- 限制：注释内容中不得包含闭合符号`*/`，否则会导致注释提前终止。
- 位置：可独立成行，或置于语句末尾。

### 示例

以下示例仅用于演示注释的位置和写法，不限定具体产品中的执行入口。

````
'''
/* 示例：跨越多行的块注释
   此处可描述复杂查询逻辑 */
statement_1
statement_2
/* 单行块注释示例 */
statement_3  /* 此注释说明该语句的作用 */
'''

````

以下是包含闭合符号`*/`的错误块注释示例：

````
'''
/* 错误示例：注释内包含闭合符号 */ */
statement_1
statement_2
'''

````

Note

第二个`*/`会被识别为注释结束符，导致后续语句被误解析。