在MySQL的开发和使用过程中，注释是提升SQL代码可读性的重要工具，无论是编写查询语句、创建表结构还是定义存储过程，合适的注释都能让代码逻辑更清晰，也方便后续的维护工作。MySQL支持多种注释语法，不同语法适用于不同的场景，开发者可以根据实际需求选择使用。
MySQL支持的注释类型
单行注释
MySQL的单行注释有两种常用语法，第一种是使用#符号，该符号后面的内容都会被当作注释处理，直到行尾结束。第二种是使用--（两个减号）加一个空格的形式，同样后面的内容属于注释内容。
以下是单行注释的使用示例：
-- 这是使用双减号加空格的单行注释，查询用户表中所有状态为正常的用户 # 这是使用#符号的单行注释，下面的语句筛选年龄大于18的用户 SELECT user_id, user_name, age FROM user WHERE status = 1 AND age > 18;
多行注释
多行注释使用/*开头，*/结尾，中间的所有内容都会被当作注释，支持跨多行书写，适合对较长的逻辑或者复杂的代码块进行说明。
多行注释的使用示例如下：
/* 这是一个多行注释示例 下面的语句用于统计不同部门的员工数量 只统计入职时间超过1年的员工 */ SELECT department_id, COUNT(*) AS emp_count FROM employee WHERE entry_time < DATE_SUB(NOW(), INTERVAL 1 YEAR) GROUP BY department_id;
不同场景下的注释使用
表结构添加注释
在创建表或者修改表结构的时候，可以给表和字段添加注释，方便后续查看表结构的时候快速了解字段的含义。创建表时可以在字段定义后使用COMMENT关键字添加字段注释，在表定义末尾添加表注释。
创建带注释的表的示例：
CREATE TABLE product (
product_id INT PRIMARY KEY AUTO_INCREMENT COMMENT '商品ID',
product_name VARCHAR(100) NOT NULL COMMENT '商品名称',
price DECIMAL(10,2) NOT NULL COMMENT '商品单价',
stock INT DEFAULT 0 COMMENT '商品库存'
) COMMENT '商品信息表';
如果已经创建了表，需要给字段添加或者修改注释，可以使用ALTER TABLE语句：
-- 修改product表的price字段注释 ALTER TABLE product MODIFY COLUMN price DECIMAL(10,2) NOT NULL COMMENT '商品单价，单位元';
存储过程和函数中的注释
在定义存储过程、函数或者触发器的时候，同样可以使用注释说明逻辑，提升代码的可维护性。可以在代码开头说明存储过程的功能、参数含义，在复杂逻辑处添加单行或者多行注释。
存储过程中使用注释的示例：
DELIMITER //
CREATE PROCEDURE update_user_status(IN user_id INT, IN new_status INT)
BEGIN
/*
存储过程功能：更新指定用户的状态
参数说明：
user_id：要更新的用户ID
new_status：新的状态值，1正常 0禁用
*/
-- 更新用户状态
UPDATE user SET status = new_status WHERE id = user_id;
-- 记录状态变更日志
INSERT INTO user_status_log(user_id, old_status, new_status, update_time)
SELECT user_id, status, new_status, NOW() FROM user WHERE id = user_id;
END //
DELIMITER ;
使用注释的注意事项
- 使用
--作为单行注释时，减号后面必须加一个空格，否则MySQL会无法识别注释，导致语法错误。 - 多行注释不支持嵌套使用，如果在一个多行注释内部再写
/*，会被当作普通字符处理，不会开启新的注释块。 - 表和字段的
COMMENT注释长度有限制，MySQL中字段注释的最大长度是1024个字符，表的注释最大长度是4096个字符，超出部分会被截断。 - 注释不会影响SQL语句的执行效率，MySQL在执行SQL时会忽略所有注释内容，开发者可以放心添加必要的注释。
合理使用MySQL注释可以让代码更易读易维护，建议开发者在编写SQL代码时，对复杂的逻辑、重要的业务规则以及不直观的字段含义都添加对应的注释，养成良好的编码习惯。