如何输入 SQL 注释

您可以添加注释以阐明特定 SQL 语句的作用和影响。您还可以在程序开发期间使用注释符号以禁用个别语句,而无需从源代码中删除它们。

您的注释可帮助您或其他人理解程序、SPL 例程或命令文件中的语句角色。本手册中的代码示例有时包括阐明代码中的 SQL 语句角色的注释,但如果在写程序时经常使用注释,那么您自己的 SQL 程序将更容易阅读和维护。

下表显示了可在代码中输入的 SQL 注释指示符。这里列中的 Y 表示您可以将此符号与列标题中标识的产品或数据库类型一起使用。列中的 N 表示不能将此符号与指出的产品或指出的 ANSI 一致性状态的数据库一起使用。

注释符号 ESQL/C SPL 例程 DB-Access 符合 ANSI 的数据库 数据库不 ANSI 符合 描述
双连字符(--) Y Y Y Y Y 在单独一行中,双连字符放在注释的前面。要对多行做出注释,请将双连字符放在每个注释行的开头。
花括号 ( { . . . } ) N Y Y Y Y 花括号将注释括起来。{放在注释的前面}放在注释后面。花括号可以定界单行或多行注释,但不能嵌套注释。
斜杠和星号 /* . . . */ Y Y Y Y Y C 语言样式的斜杠和星号( /* */ )成对定界符将注释括在其中。/* 放在注释前面,*/放在注释后面。这些符号可以定界单行或多行注释,但不能嵌套注释。

数据库服务器忽略注释中的字符。

优化程序伪指令 这一部分描述了上下文,在该上下文中注释内的信息可以影响 GBase 8s 的查询计划。

如果您使用的产品支持所有这些注释符号,则您选择的注释符号取决于对 ANSI/ISO 一致性的需求:

只要符合 ANSI/ISO 一致性,您对注释符号的选择纯属个人偏好。

DB-Access 中,当您使用 SQL 编辑器输入 SQL 语句和当您使用 SQL 编辑器或系统编辑器创建 SQL 命令文件时,可以使用这些注释符号中的任何符号。

SQL 命令文件是包含一条或多条 SQL 语句的操作系统文件。命令文件也称为命令脚本。关于命令文件的更多信息,请参阅 GBase 8s SQL 教程指南 中命令脚本的讨论。关于如何在 DB-Access 中使用 SQL 编辑器或系统编辑器创建和修改命令文件的信息,请参阅 GBase 8s DB-Access 用户指南

您可以在 SPL 例程的任意一行中使用任意一种注释符号。请参阅 GBase 8s SQL 教程指南 中关于如何注释和记录 SPL 例程的讨论。

GBase 8s ESQL/C 中,以连字符(--)开始的注释可以延伸到同一行的末尾。关于 GBase 8s ESQL/C 程序中特定于语言的注释符号的信息,请参阅 GBase 8s ESQL/C 程序员手册