0025. SQL 中的注释写法
1. 📝 概述
- 在 SQL 中,注释用于对代码进行说明、调试或临时禁用部分语句。
- SQL 支持多种注释写法,主要包括 单行注释 和 多行注释。
- 单行注释:使用
--
或#
开头,直到行末。- 推荐
--
#
仅适用于 MySQL
- 推荐
- 多行注释:使用
/*
开头,直到*/
结束。
- 单行注释:使用
- 注意事项
- 注释不会被执行,但可以被阅读者看到。
- 不要将敏感信息写入注释中(例如密码、配置等),因为注释可能被他人查看。
- 在调试时,可以用注释临时“屏蔽”某段 SQL 语句。
- 想要执行部分 SQL,注释掉暂时不需要的 SQL 是一种方法,除了使用注释之外,你也可以尝试选中需要执行的 SQL 语句,然后通过快捷方式
Ctrl/Cmd+Enter
运行(大部分 SQL 工具都支持这种快捷方式)。
- 想要执行部分 SQL,注释掉暂时不需要的 SQL 是一种方法,除了使用注释之外,你也可以尝试选中需要执行的 SQL 语句,然后通过快捷方式
注释类型 | 示例 | 数据库支持 |
---|---|---|
单行注释(-- ) | -- 查询用户表 | 所有主流数据库 |
单行注释(# ) | # 查询用户表 | 仅 MySQL |
多行注释(/*...*/ ) | /* 注释内容 */ | 所有主流数据库 |
2. 💻 单行注释
- 方法一:
--
(两个连字符) - 这是最常用的单行注释方式,适用于大多数数据库系统(如 MySQL、PostgreSQL、SQL Server 等)。
- 注意:在
--
后面需要加一个空格。
sql
-- 这是一条单行注释
SELECT * FROM users;
1
2
2
- 方法二:
#
(井号) - 仅在 MySQL 中支持这种写法。
sql
# 这也是一条单行注释
SELECT * FROM users;
1
2
2
3. 💻 多行注释
- 使用
/* ... */
可以实现跨多行的注释,适用于所有主流数据库系统。
sql
/*
这是一个
多行注释
*/
SELECT * FROM users;
1
2
3
4
5
2
3
4
5