2022-09-17 02:57:57
SQL 中的注释符号用于增强代码可读性,以下是详细的分类和说明:
一、标准注释符号单行注释
--:注释当前行 -- 之后的所有内容,需注意符号后至少有一个空格(部分数据库允许无空格)。-- 查询用户表SELECT * FROM users;
多行注释
/* */:可跨行注释,适用于大段说明或临时禁用代码块。/* 以下代码用于统计活跃用户 时间范围:2023年1月至今 */SELECT COUNT(*) FROM users WHERE last_login > '2023-01-01';
#
MySQL/MariaDB 专用,注释单行内容(类似 --)。# 临时禁用此查询# SELECT * FROM deprecated_table;
REM
SQL Server 支持的单行注释(不常见,推荐使用 --)。REM 此表已迁移至新架构-- SELECT * FROM old_schema.table;
BEGIN ATOMIC ... END ATOMIC
PostgreSQL 特性,用于定义原子块(非传统注释,但影响代码逻辑)。BEGIN ATOMIC INSERT INTO logs VALUES ('Transaction started'); -- 其他操作...END ATOMIC;
简洁性:注释应聚焦于“为什么”而非“做什么”(代码本身应自解释)。
❌ 避免:-- 循环遍历数组(代码已体现)
✅ 推荐:-- 处理用户权限升级逻辑
一致性:团队统一风格(如全用 -- 或 #)。
维护性:修改代码时同步更新注释,避免误导。
通过合理使用注释,可以显著提升 SQL 脚本的可维护性,尤其在复杂查询或存储过程中。