MySQL注释的三种写法之单行注释、多行注释和特殊注释的使用方法

更新时间：2026年03月04日 15:47:06 作者：Clf丶忆笙

本文详细介绍了MySQL注释的各个方面,包括注释的定义、重要性、三种注释方式（单行注释、多行注释和特殊注释）以及它们的使用场景、语法和最佳实践,感兴趣的朋友跟随小编一起看看吧

一、MySQL注释概述与重要性

1.1 什么是MySQL注释

MySQL注释是程序员在SQL语句中添加的说明性文字，这些文字不会被MySQL服务器执行。注释的主要目的是提高代码的可读性和可维护性，让开发者或后续维护者能够更好地理解SQL语句的意图和逻辑。

官方定义：注释是SQL标准的一部分，是"不影响语句语义的可选文本"(Optional text that does not affect the statement’s semantics)。在MySQL中，注释可以出现在SQL语句的任何位置，包括语句开始前、语句中间或语句结束后。

1.2 注释在数据库开发中的核心价值

代码文档化：注释相当于代码的说明书，解释复杂查询的逻辑、目的和实现方式
团队协作：让团队成员快速理解SQL意图，减少沟通成本
调试辅助：可以通过注释暂时禁用部分SQL语句进行测试
版本控制：记录修改历史、作者信息等重要元数据
SQL语句生成：某些工具会解析注释生成文档或API

1.3 MySQL支持的三种注释方式

MySQL支持三种注释语法，每种都有其特定的使用场景和语法规则：

单行注释（两种形式）
- 双横线注释：-- 注释内容
- 井号注释：# 注释内容
多行注释：/* 注释内容 */
特殊注释（可执行注释）：/*! 特定代码 */

这三种注释方式将在后续章节中详细展开，我们会探讨每种注释的具体语法、使用场景、注意事项以及最佳实践。

1.4 注释与SQL性能的关系

虽然注释本身不会影响SQL的执行性能，但良好的注释习惯可以间接提升开发效率和系统性能：

合理的注释可以帮助开发者快速定位性能瓶颈
注释中可以记录SQL优化思路和索引使用建议
避免因代码难以理解而导致的次优实现
特殊注释可用于处理不同MySQL版本间的兼容性问题

二、MySQL单行注释详解

2.1 双横线单行注释(–)

2.1.1 基本语法与使用

双横线注释是SQL标准中定义的单行注释方式，其基本语法为：

-- 这是单行注释
SELECT * FROM users; -- 这是语句后的注释

关键特点：

必须以两个连续的横线开头(--)
横线后必须紧跟一个空格或控制字符(如制表符)
注释范围从--开始到行尾结束
可以出现在SQL语句的任何位置

2.1.2 实际应用示例

-- 用户基本信息查询
-- 创建时间：2023-05-20
-- 创建者：DBA团队
SELECT 
    user_id, -- 用户唯一标识
    username, -- 登录用户名
    email -- 注册邮箱
FROM 
    users
WHERE 
    status = 1; -- 1表示活跃用户

代码解析：

前三个注释作为整个查询的文档说明
字段后的注释解释每个字段的含义
WHERE条件后的注释说明业务逻辑

2.1.3 注意事项与常见错误

空格要求：--后必须有空格，否则不被识别为注释
错误示例：SELECT * FROM users--注释（无效）
正确写法：SELECT * FROM users -- 注释
多行限制：每行注释都需要独立的--前缀

-- 第一行注释
-- 第二行注释

字符串中的双横线：在字符串值中的--不会被解析为注释

INSERT INTO logs (message) VALUES ('--这不是注释');

事务中的注释：注释会随整个事务一起记录到binlog中

2.2 井号单行注释(#)

2.2.1 基本语法与使用

井号注释是MySQL特有的单行注释方式，源自Unix shell脚本传统：

# 这是井号注释
SELECT * FROM products # 这也是井号注释

关键特点：

以单个#字符开头
不需要在#后添加空格(但建议添加以提高可读性)
注释范围从#开始到行尾结束
可以出现在SQL语句的任何位置

2.2.2 实际应用示例

# 产品库存报表
# 版本：1.2
# 最后更新：2023-06-15
SELECT 
    p.product_id,    # 产品ID
    p.product_name,  # 产品名称
    s.quantity       # 当前库存量
FROM 
    products p
JOIN 
    stock s # 库存表
    ON p.product_id = s.product_id
WHERE 
    p.discontinued = 0; # 0表示在售产品

代码解析：

井号注释同样可以用于语句前、语句中和语句后
相比--注释，#注释不需要强制空格，格式更自由
常用于脚本文件或命令行中的临时注释

2.2.3 与双横线注释的比较

特性	`--`注释	`#`注释
标准符合性	SQL标准	MySQL特有
空格要求	必须后跟空格	可选
可读性	较高(显式分隔)	稍低(可能紧贴内容)
使用场景	正式代码、标准SQL	脚本、临时查询
工具支持	所有SQL工具	主要MySQL客户端

2.2.4 使用建议

在需要符合SQL标准的场景下优先使用--注释
在MySQL专属脚本或命令行中可使用#简化书写
团队项目中应统一注释风格
即使#不要求空格，也建议添加空格提高可读性

2.3 单行注释的高级应用

2.3.1 注释与SQL语句调试

单行注释常用于临时禁用部分SQL语句进行调试：

SELECT 
    user_id,
    username,
    -- email,
    phone_number
FROM 
    users
WHERE 
    -- status = 1 AND 
    registration_date > '2023-01-01';

调试技巧：

通过注释排除可能的问题字段或条件
逐步取消注释以定位问题
可配合版本控制系统，避免丢失原始代码

2.3.2 注释与SQL注入防护

良好的注释习惯有助于防止SQL注入：

-- 不安全写法(拼接SQL)
SET @sql = CONCAT('SELECT * FROM users WHERE username="', @input, '"');
PREPARE stmt FROM @sql;
EXECUTE stmt;
-- 安全写法(参数化查询)
PREPARE stmt FROM 'SELECT * FROM users WHERE username=?';
EXECUTE stmt USING @input;

安全建议：

在敏感操作处添加安全注释提醒
注释中记录输入验证和过滤要求
避免在注释中暴露敏感信息

2.3.3 注释与自动化文档生成

许多文档工具可以解析SQL注释生成API文档：

-- @api {get} /users 获取用户列表
-- @apiGroup User
-- @apiParam {Number} [page=1] 页码
-- @apiParam {Number} [limit=20] 每页数量
SELECT * FROM users LIMIT :limit OFFSET (:page - 1) * :limit;

文档化建议：

采用标准化的注释格式(如apidoc/jsdoc)
保持注释与实现同步更新
为公共接口添加详细的参数说明

三、MySQL多行注释深度解析

3.1 标准多行注释语法(/* */)

3.1.1 基本语法结构

MySQL多行注释采用C语言风格的/* */语法：

/* 这是一个
多行注释 */
SELECT * FROM employees;

核心特点：

以/*开始，以*/结束
可以跨越多行，也可以单行使用
注释内容可以包含任何字符(包括单引号、双引号)
不能嵌套使用(即注释内不能再有/* */)

3.1.2 多行注释的典型应用场景

复杂SQL的说明文档：

/*
 * 员工薪资统计报表
 * 功能：计算各部门薪资分布
 * 包含：基本工资、奖金、补贴
 * 排除：已离职员工
 * 作者：HR系统团队
 * 版本：2.1
 */
SELECT 
    department_id,
    AVG(salary) AS avg_salary
FROM 
    employees
WHERE 
    status = 'active'
GROUP BY 
    department_id;

临时禁用代码块：

SELECT product_name FROM products;
/*
SELECT product_name 
FROM products 
WHERE discontinued = 0
ORDER BY create_time DESC;
*/

SQL语句分段说明：

SELECT 
    /* 获取客户基本信息 */
    c.customer_id,
    c.customer_name,
    /* 计算订单总额 */
    SUM(o.amount) AS total_amount
FROM 
    customers c
    /* 关联订单表 */
    LEFT JOIN orders o ON c.customer_id = o.customer_id
GROUP BY 
    c.customer_id, c.customer_name;

3.1.3 多行注释的格式化技巧

为提高可读性，建议采用以下格式化风格：

星号对齐风格：

/*
 * 第一行注释
 * 第二行注释
 * 第三行注释
 */

段落分隔风格：

/*=============================================
 * 模块名称：用户权限管理
 * 主要功能：查询用户权限列表
 * 调用关系：
 *   - 依赖roles表
 *   - 被admin模块调用
 =============================================*/

紧凑单行风格：

/* 单行注释也可以使用多行语法 */

3.2 多行注释的嵌套问题与解决方案

3.2.1 MySQL注释嵌套限制

标准SQL不允许注释嵌套，以下写法会导致语法错误：

/* 外层注释
   /* 内层注释 */
   这部分会被当作SQL语句执行 */

实际效果：

第一个/*开始注释
遇到第一个*/时注释结束
后续内容会被当作SQL语句解析，导致错误

3.2.2 临时解决方案

虽然不能真正嵌套，但可以通过以下方式模拟：

条件注释模拟嵌套：

/* 外层注释 */
/*! 内层"注释"实际上是可以执行的代码 */
/* 外层注释继续 */

使用单行注释替代：

/* 外层注释开始
-- 内层"注释"使用单行形式
外层注释继续 */

版本条件注释：

/*!50100 这部分在MySQL 5.1.00+会执行
/* 这看起来像嵌套但不是真正的嵌套 */
*/

3.2.3 最佳实践建议

避免设计需要嵌套注释的场景
复杂说明拆分为多个独立注释块
使用文档工具生成外部文档而非依赖代码注释
对于必须的"嵌套"，采用条件注释方式

3.3 多行注释与存储程序

3.3.1 存储过程中的注释规范

存储程序尤其需要详细的注释说明：

DELIMITER //
/*====================================
 * 存储过程：update_customer_status
 * 功能：批量更新客户状态
 * 参数：
 *   - p_customer_ids: 客户ID列表(逗号分隔)
 *   - p_new_status: 新状态值
 * 返回值：受影响的行数
 * 创建日期：2023-03-15
 * 修改历史：
 *   2023-04-01 增加事务处理
 ====================================*/
CREATE PROCEDURE update_customer_status(
    IN p_customer_ids TEXT,
    IN p_new_status INT,
    OUT p_affected_rows INT
)
BEGIN
    /* 声明变量 */
    DECLARE v_start_time DATETIME DEFAULT NOW();
    /* 记录操作日志 */
    INSERT INTO procedure_logs (proc_name, start_time)
    VALUES ('update_customer_status', v_start_time);
    /* 主处理逻辑 */
    SET @sql = CONCAT('UPDATE customers SET status = ', 
                     p_new_status, 
                     ' WHERE customer_id IN (', 
                     p_customer_ids, ')');
    PREPARE stmt FROM @sql;
    EXECUTE stmt;
    SET p_affected_rows = ROW_COUNT();
    DEALLOCATE PREPARE stmt;
    /* 更新日志 */
    UPDATE procedure_logs 
    SET end_time = NOW(),
        affected_rows = p_affected_rows
    WHERE proc_name = 'update_customer_status'
    AND start_time = v_start_time;
END //
DELIMITER ;

注释要点：

头部注释说明整体功能
参数详细说明
关键步骤注释
修改历史记录

3.3.2 函数中的注释示例

DELIMITER //
/*
 * 函数名称：calculate_discount
 * 功能：基于订单金额计算折扣率
 * 参数：
 *   - p_order_amount: 订单金额(DECIMAL)
 * 返回值：折扣率(DECIMAL)
 * 业务规则：
 *   - 金额<100: 无折扣
 *   - 100≤金额<500: 5%折扣
 *   - 500≤金额<1000: 8%折扣
 *   - 金额≥1000: 10%折扣
 */
CREATE FUNCTION calculate_discount(p_order_amount DECIMAL(10,2))
RETURNS DECIMAL(3,2)
DETERMINISTIC
BEGIN
    DECLARE v_discount DECIMAL(3,2) DEFAULT 0.00;
    /* 应用折扣规则 */
    IF p_order_amount >= 100 AND p_order_amount < 500 THEN
        SET v_discount = 0.05;
    ELSEIF p_order_amount >= 500 AND p_order_amount < 1000 THEN
        SET v_discount = 0.08;
    ELSEIF p_order_amount >= 1000 THEN
        SET v_discount = 0.10;
    END IF;
    RETURN v_discount;
END //
DELIMITER ;

3.3.3 触发器注释规范

DELIMITER //
/*====================================
 * 触发器：tri_after_order_insert
 * 表：orders
 * 时机：AFTER INSERT
 * 功能：订单创建后更新客户最后购买时间
 * 逻辑：
 *   - 获取新订单的客户ID
 *   - 更新customers表的last_purchase字段
 ====================================*/
CREATE TRIGGER tri_after_order_insert
AFTER INSERT ON orders
FOR EACH ROW
BEGIN
    /* 更新客户最后购买时间 */
    UPDATE customers 
    SET last_purchase = NOW()
    WHERE customer_id = NEW.customer_id;
    /* 记录触发器执行日志 */
    INSERT INTO trigger_logs 
    (trigger_name, affected_table, execution_time)
    VALUES 
    ('tri_after_order_insert', 'orders', NOW());
END //
DELIMITER ;

四、MySQL特殊注释详解

4.1 可执行注释语法(/! /)

4.1.1 基本概念与语法

MySQL特殊注释，也称为可执行注释或条件注释，采用/*! */语法：

/*! SELECT 1+1; */

核心特点：

注释内容会被MySQL服务器执行
主要用于版本特定的SQL代码
语法为/*! [MySQL版本号] SQL代码 */
省略版本号时表示在所有版本执行

4.1.2 版本特定代码的实现

特殊注释最常见的用途是处理不同MySQL版本间的语法差异：

CREATE TABLE example (
    id INT PRIMARY KEY,
    data JSON /*!50706 COMMENT 'JSON类型要求MySQL 5.7.6+' */
);

执行规则：

当MySQL版本≥指定版本时，注释内代码会被执行
当版本<指定版本时，整个注释(包括内容)会被忽略
版本号格式为5位数字：主版本(1)+次版本(2)+发布号(2)

4.1.3 实际应用案例

案例1：JSON支持：

CREATE TABLE products (
    id INT PRIMARY KEY,
    /*!50706 details JSON, */
    /*!50706 full_text TEXT GENERATED ALWAYS AS (details->>"$.description") STORED, */
    price DECIMAL(10,2)
);

案例2：窗口函数：

SELECT 
    employee_id,
    department_id,
    salary,
    /*!80021 RANK() OVER (PARTITION BY department_id ORDER BY salary DESC) AS dept_rank */
FROM 
    employees;

案例3：身份验证插件：

CREATE USER 'newuser'@'localhost' 
IDENTIFIED /*!50706 WITH caching_sha2_password */ BY 'password';

4.2 特殊注释的高级应用

4.2.1 数据库迁移脚本

特殊注释在数据库迁移脚本中特别有用：

/*!40101 SET @OLD_CHARACTER_SET_CLIENT=@@CHARACTER_SET_CLIENT */;
/*!40101 SET @OLD_CHARACTER_SET_RESULTS=@@CHARACTER_SET_RESULTS */;
/*!40101 SET @OLD_COLLATION_CONNECTION=@@COLLATION_CONNECTION */;
/*!40101 SET NAMES utf8mb4 */;
/*!40103 SET @OLD_TIME_ZONE=@@TIME_ZONE */;
/*!40103 SET TIME_ZONE='+00:00' */;
/*!40014 SET @OLD_UNIQUE_CHECKS=@@UNIQUE_CHECKS, UNIQUE_CHECKS=0 */;
/*!40014 SET @OLD_FOREIGN_KEY_CHECKS=@@FOREIGN_KEY_CHECKS, FOREIGN_KEY_CHECKS=0 */;
/*!40101 SET @OLD_SQL_MODE=@@SQL_MODE, SQL_MODE='NO_AUTO_VALUE_ON_ZERO' */;
/*!40111 SET @OLD_SQL_NOTES=@@SQL_NOTES, SQL_NOTES=0 */;
-- 实际迁移SQL...
/*!40103 SET TIME_ZONE=@OLD_TIME_ZONE */;
/*!40101 SET SQL_MODE=@OLD_SQL_MODE */;
/*!40014 SET FOREIGN_KEY_CHECKS=@OLD_FOREIGN_KEY_CHECKS */;
/*!40014 SET UNIQUE_CHECKS=@OLD_UNIQUE_CHECKS */;
/*!40101 SET CHARACTER_SET_CLIENT=@OLD_CHARACTER_SET_CLIENT */;
/*!40101 SET CHARACTER_SET_RESULTS=@OLD_CHARACTER_SET_RESULTS */;
/*!40101 SET COLLATION_CONNECTION=@OLD_COLLATION_CONNECTION */;
/*!40111 SET SQL_NOTES=@OLD_SQL_NOTES */;

4.2.2 存储引擎指定

CREATE TABLE example (
    id INT PRIMARY KEY
) /*!50100 ENGINE = InnoDB */;

4.2.3 字符集设置

CREATE TABLE multilingual (
    id INT PRIMARY KEY,
    content VARCHAR(100) /*!50500 CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci */
);

4.3 特殊注释与优化器提示

4.3.1 优化器提示语法

MySQL 8.0+支持优化器提示注释：

SELECT /*+ MAX_EXECUTION_TIME(1000) */ * FROM large_table;

4.3.2 常用优化器提示

执行超时控制：

/*+ MAX_EXECUTION_TIME(500) */

索引提示：

/*+ INDEX(table idx_name) */

连接顺序控制：

/*+ JOIN_ORDER(t1, t2, t3) */

子查询策略：

/*+ SEMIJOIN(FIRSTMATCH) */

4.3.3 实际应用示例

/* 复杂查询优化示例 */
SELECT 
    /*+ 
        MAX_EXECUTION_TIME(1000)
        BKA(c)
        NO_RANGE_OPTIMIZATION(o)
    */
    c.customer_name,
    o.order_date,
    o.amount
FROM 
    customers c
    JOIN orders o /*+ JOIN_ORDER(c, o) */ 
        ON c.customer_id = o.customer_id
WHERE 
    o.order_date > '2023-01-01'
ORDER BY 
    o.amount DESC;

五、MySQL注释最佳实践

5.1 注释规范与风格指南

5.1.1 通用注释原则

清晰性：注释应解释"为什么"而非"是什么"
简洁性：避免过度注释显而易见的代码
及时性：代码修改时同步更新注释
一致性：团队采用统一的注释风格

5.1.2 字段级注释规范

CREATE TABLE employees (
    emp_id INT PRIMARY KEY COMMENT '员工唯一标识，自动递增',
    emp_name VARCHAR(50) NOT NULL COMMENT '员工姓名，最多50个字符',
    salary DECIMAL(10,2) COMMENT '月薪，包含基本工资和岗位工资',
    hire_date DATE COMMENT '入职日期，YYYY-MM-DD格式'
) COMMENT='公司员工基本信息表';

最佳实践：

每个字段都应有关联的COMMENT
说明字段的业务含义而非数据类型
记录特殊约束或业务规则
表级注释说明整体用途

5.1.3 查询注释规范

/*
 * 查询名称：monthly_sales_report
 * 功能：生成分地区月度销售报表
 * 业务逻辑：
 *   - 只统计已完成的订单(status=3)
 *   - 排除测试账号(user_type=9)
 *   - 按地区和月份分组汇总
 * 性能说明：
 *   - 使用idx_region_time复合索引
 *   - 结果集预计100-200行
 * 修改历史：
 *   2023-01-15 增加退货金额计算
 *   2023-03-22 优化地区关联方式
 */
SELECT 
    r.region_name,
    DATE_FORMAT(o.order_time, '%Y-%m') AS month,
    SUM(o.amount) AS total_sales,
    COUNT(DISTINCT o.customer_id) AS customer_count
FROM 
    orders o
    JOIN regions r ON o.region_id = r.region_id
WHERE 
    o.status = 3
    AND o.user_type != 9
GROUP BY 
    r.region_name, 
    DATE_FORMAT(o.order_time, '%Y-%m');

5.2 注释与性能优化

5.2.1 执行计划注释

/* 
 * 执行计划说明：
 *   - 使用idx_composite覆盖索引避免回表
 *   - 范围扫描约500行
 *   - 临时表排序预计需要1MB内存
 */
EXPLAIN 
SELECT product_id, product_name 
FROM products 
WHERE category_id = 5 
AND price BETWEEN 100 AND 500
ORDER BY create_time DESC;

5.2.2 索引使用提示

-- 强制使用特定索引(适用于优化器选择不佳时)
SELECT * FROM orders FORCE INDEX(idx_order_date) 
WHERE order_date BETWEEN '2023-01-01' AND '2023-01-31';
-- 忽略特定索引(适用于索引过多干扰优化器)
SELECT * FROM orders IGNORE INDEX(idx_customer_id)
WHERE customer_id = 100 AND status = 1;

5.2.3 查询重写记录

/*
 * 原始查询：使用子查询方式，执行时间约2.3秒
 * SELECT * FROM products WHERE category_id IN 
 * (SELECT category_id FROM categories WHERE department = 'electronics')
 * 
 * 优化后：使用JOIN改写，执行时间约0.8秒
 * 优化思路：避免DEPENDENT SUBQUERY
 */
SELECT p.* 
FROM products p
JOIN categories c ON p.category_id = c.category_id
WHERE c.department = 'electronics';

5.3 注释工具与自动化

5.3.1 文档生成工具

mysqldoc：从注释生成HTML文档
Dataedo：可视化数据库文档工具
SchemaSpy：分析数据库结构生成文档

5.3.2 注释提取示例

-- 使用mysqldoc格式的注释
-- @table products 产品信息表
-- @description 存储公司所有产品的基本信息
-- @author DBA Team
-- @field product_id 产品ID，主键
-- @field product_name 产品名称，唯一
-- @field price 零售价格，单位元
CREATE TABLE products (
    product_id INT PRIMARY KEY,
    product_name VARCHAR(100) UNIQUE,
    price DECIMAL(10,2)
);

5.3.3 版本控制集成

/*
 * $Id$
 * $HeadURL$
 * $LastChangedRevision$
 * $LastChangedBy$
 * $LastChangedDate$
 */
CREATE TABLE inventory (
    item_id INT PRIMARY KEY,
    quantity INT NOT NULL DEFAULT 0
);

六、MySQL注释的进阶话题

6.1 注释与字符集问题

6.1.1 注释中的特殊字符

-- 包含特殊字符的注释
SELECT * FROM translations 
WHERE text LIKE '%注释%'; -- 这里的"注释"是中文
/* 
 * 多语言注释示例
 * 日本語のコメント
 * русский комментарий
 * 中文注释
 */

处理建议：

脚本文件使用UTF-8编码
连接设置SET NAMES utf8mb4
避免在注释中使用可能被误解析的控制字符

6.1.2 字符集不一致问题

当客户端和服务端字符集不一致时，注释可能出现乱码：

解决方案：

-- 显式设置客户端字符集
SET character_set_client = utf8mb4;
SET character_set_connection = utf8mb4;
SET character_set_results = utf8mb4;
/* 现在可以安全使用多语言注释 */

6.2 注释在复制环境中的行为

6.2.1 主从复制中的注释处理

默认情况下，注释会原样复制到从库
在ROW格式binlog中，注释不包含在行变更中
在STATEMENT格式binlog中，完整SQL语句(含注释)会被记录

6.2.2 过滤复制中的注释

可以在从库配置过滤规则：

[mysqld]
replicate-wild-ignore-table=%.comments_table

6.3 注释与安全考虑

6.3.1 敏感信息泄露

避免在注释中包含：

数据库连接信息
密码或加密密钥提示
系统架构细节
安全控制措施说明

6.3.2 SQL注入风险

-- 不安全：注释可能被注入闭合
SELECT * FROM users WHERE id = 1 /* AND admin = 1 */;
-- 安全：使用参数化查询
PREPARE stmt FROM 'SELECT * FROM users WHERE id = ?';
EXECUTE stmt USING @user_id;

6.4 注释的性能开销

6.4.1 解析开销测试

通过基准测试比较带注释和不带注释的SQL执行：

-- 测试查询(不带注释)
SELECT BENCHMARK(1000000, (SELECT 1 FROM dual));
-- 测试查询(带大量注释)
SELECT /* 大量注释... */ BENCHMARK(1000000, 
(SELECT /* 子查询注释 */ 1 FROM dual /* dual表注释 */));

结论：

注释会增加少量解析时间
对简单查询影响较明显(微秒级)
对复杂查询几乎无影响

6.4.2 网络传输影响

大型注释会增加SQL文本大小，影响网络传输：

优化建议：

生产环境移除调试注释
使用简洁的注释风格
重要注释保存在文档而非代码中

七、MySQL注释的实用技巧

7.1 调试技巧与注释

7.1.1 条件执行调试

SELECT 
    user_id,
    username,
    /* DEBUG: email, */
    phone_number
FROM 
    users
WHERE 
    status = 1
    /* AND account_type = 'premium' */

7.1.2 执行时间标记

/* 查询开始时间：2023-07-20 14:30:00 */
SELECT * FROM large_table;
/* 查询结束时间：2023-07-20 14:30:05 */

7.1.3 性能分析辅助

/* 开启性能分析 */
SET profiling = 1;
-- 执行待分析查询
SELECT * FROM orders WHERE order_date > '2023-01-01';
/* 查看分析结果 */
SHOW PROFILE;

7.2 注释与SQL生成

7.2.1 动态SQL构建

/* 动态SQL生成示例 */
SET @table_name = 'employees';
SET @sql = CONCAT('SELECT * FROM ', @table_name, ' /* 来源表：', @table_name, ' */');
PREPARE stmt FROM @sql;
EXECUTE stmt;

7.2.2 存储过程调试

CREATE PROCEDURE debug_procedure()
BEGIN
    DECLARE v_debug BOOL DEFAULT TRUE;
    /* 调试输出 */
    IF v_debug THEN
        SELECT 'Procedure started' AS debug_log;
    END IF;
    -- 主逻辑...
    /* 调试输出 */
    IF v_debug THEN
        SELECT CONCAT('Rows affected: ', ROW_COUNT()) AS debug_log;
    END IF;
END;

7.3 注释与版本控制

7.3.1 变更记录

/*
 * 变更记录：
 * 2023-01-10 v1.0 初始创建
 * 2023-02-15 v1.1 增加status字段索引
 * 2023-03-20 v1.2 调整price字段精度
 */
ALTER TABLE products
ADD INDEX idx_status (status),
MODIFY COLUMN price DECIMAL(12,2);

7.3.2 Git集成

-- git-blame: 了解每行修改历史
-- git-log: 查看完整变更记录
/*
 * 最后修改人：john.doe@example.com
 * 最后修改时间：2023-05-15 14:30
 * 提交哈希：a1b2c3d4
 */

八、MySQL注释的全面总结

8.1 三种注释方式对比

特性	单行注释(–/#)	多行注释(/* */)	特殊注释(/! /)
语法	– 或 #	/* */	/! /
是否执行内容	否	否	是
标准符合性	–是SQL标准	SQL标准	MySQL特有
典型用途	简短说明	详细文档	版本兼容代码
嵌套能力	不可嵌套	不可嵌套	可模拟嵌套
工具支持	广泛支持	广泛支持	MySQL客户端

8.2 注释使用决策树

是否需要代码被执行？
- 是：使用/*! */特殊注释
- 否：进入下一步
注释是否跨越多行？
- 是：使用/* */多行注释
- 否：进入下一步
是否需要符合SQL标准？
- 是：使用--单行注释
- 否：使用#单行注释(MySQL环境)

8.3 终极实践建议

基础原则：
- 写注释如同写代码一样认真
- 注释与代码同步更新
- 避免无意义的注释
技术建议：
- 生产环境移除调试注释
- 使用工具自动化文档生成
- 重要设计决策记录在注释中
团队规范：
- 制定统一的注释风格指南
- 进行定期的注释评审
- 将注释质量纳入代码审查标准

通过本指南的系统学习，您应该已经掌握了MySQL注释的全面知识体系。从基础的单行注释到高级的特殊注释应用，良好的注释习惯将显著提升您的数据库开发效率和代码质量。记住，优秀的注释不是可有可无的附属品，而是专业数据库开发的重要组成部分。

到此这篇关于MySQL注释的三种写法之单行注释、多行注释和特殊注释的使用方法的文章就介绍到这了,更多相关mysql单行注释、多行注释和特殊注释内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

深入了解MySQL ClickHouse中的物化视图功能
MapReduce是一种用于处理大规模数据集的并行编程模型，其特点高效性和可扩展性，这篇文章主要介绍了MySQL ClickHouse中的物化视图功能，需要详细了解可以参考下文
2023-05-05
MySQL使用慢查询日志Slow Log定位低效SQL的全过程
在 MySQL 数据库运维中,SQL 语句的执行效率直接影响系统响应速度,当网站出现卡顿、接口超时等问题时,慢查询日志（Slow Log）往往是定位低效SQL的第一手证据,本文给大家介绍了MySQL使用慢查询日志Slow Log定位低效SQL的全过程,需要的朋友可以参考下
2026-02-02
在MySQL中使用序列的简单教程
这篇文章主要介绍了在MySQL中使用序列的简单教程,是MySQL入门学习中的基础知识,文中给出了基于PHP和Perl脚本的示例,需要的朋友可以参考下
2015-05-05
MySQL中的当前读和快照读的区别
在MySQL中,当前读和快照读是事务中的两种重要的读取方式,当前读,即锁定读,会对读取的行记录加锁,确保数据一致性,两者的主要区别在于锁定机制、数据一致性、并发性能和幻读问题,理解这些差异有助于根据业务需求选择合适的读取方式,保证数据库的事务隔离性和一致性
2024-09-09
mysql常用函数之group_concat()、group by、count()、case whe
本文主要介绍了mysql常用函数之group_concat()、group by、count()、case when then的使用，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2023-01-01
Mysql数据迁徙方法工具解析
这篇文章主要介绍了mysql数据迁徙方法工具解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2019-12-12
docker搭建mysql主从同步的全过程
这篇文章主要介绍了docker搭建mysql主从同步的全过程,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
2024-04-04
Mysql数据库定时备份脚本分享
这篇文章主要分享了Mysql数据库的定时备份脚本，帮助大家更好的理解和使用MySQL数据库，感兴趣的朋友可以了解下
2020-09-09
mysql创建表设置表主键id从1开始自增的解决方案
在MySQL中用很多类型的自增ID,每个自增ID都设置了初始值,一般情况下初始值都是从0开始,然后按照一定的步长增加(一般是自增 1),下面这篇文章主要给大家介绍了关于mysql创建表设置表主键id从1开始自增的解决方案,需要的朋友可以参考下
2023-04-04
一篇文章搞懂MySQL加锁机制
线程安全就是多线程访问时,采用了加锁机制,当一个线程访问该类的某个数据时进行保护,下面这篇文章主要给大家介绍了关于MySQL加锁机制的相关资料,需要的朋友可以参考下
2022-01-01