MySQL 如何在代码中添加注释

在编写MySQL代码时，往往需要添加注释来记录代码的目的或者解释某些复杂操作的含义。MySQL支持不同的注释方式，本文将介绍如何在MySQL代码中添加注释以及其使用场景。

阅读更多：MySQL 教程

单行注释

单行注释以“–”开头，后面跟着注释内容。注释内容可以是任何描述，通常用于注释单行代码或少量代码块，如下所示：

SELECT * FROM students -- 查询学生表
WHERE age >= 18;        -- 年龄大于等于18岁

以上代码中，“查询学生表”和“年龄大于等于18岁”是两个单行注释。

多行注释

多行注释以“/”开头，以“/”结尾，中间是注释内容。多行注释可以注释多个代码块或者整段代码。如下所示：

/* 
查询年龄大于等于18岁的学生 
返回学号、姓名和年龄 
*/
SELECT sno, sname, age FROM students 
WHERE age >= 18;

以上代码中，注释了查询目的和返回内容。

存储过程注释

存储过程是一组SQL语句的集合，可以用于完成特定的业务逻辑操作。为了方便理解和维护存储过程，在编写存储过程时添加注释非常重要。 MySQL存储过程支持单行和多行注释，注释方式和普通SQL语句相同。

下面是一个带有注释的存储过程示例：

/* 
计算学生的成绩和排名 
输入参数：学号
输出参数：总分、平均分、排名
*/
CREATE PROCEDURE `score_ranking`(IN `sno` INT, OUT `total_score` FLOAT, OUT `average_score` FLOAT, OUT `ranking` INT)
BEGIN
  DECLARE score FLOAT;
  /* 获取该学生的总分 */
  SELECT SUM(score) INTO score FROM score_table WHERE sno = sno;
  /* 计算该学生的平均分 */
  SET average_score = score / (SELECT COUNT(*) FROM score_table WHERE sno = sno);
  /* 计算该学生的排名 */
  SELECT COUNT(*) + 1 INTO ranking FROM (SELECT sno, SUM(score) total_score FROM score_table GROUP BY sno) score_total WHERE total_score > score;
  /* 返回结果 */
  SET total_score = score;
END

以上代码中，注释了存储过程的目的、输入输出参数以及每行代码的作用，便于其他开发者理解和维护。