Как писать комментарии в MySQL

MySQL позволяет писать комментарии в файле запроса .sql, или при выполнении запроса из бекенда, IDE, или консоли. В этой статье разберёмся, как это делать, и какие типы комментариев существуют в Mysql.

Комментарии в запросах MySQL могут быть как однострочными, так и многострочными, в зависимости от того, какой синтаксис комментария вы используете.

Для однострочных комментариев вы можете использовать следующий синтаксис:

• -- символ двойного тире, за которым следует пробел
• # решетка

Вот пример однострочных комментариев в MySQL:

USE app; -- Выбираем базу данных под названием app

SELECT * FROM users; # Выбираем всех пользователей с таблицы

SELECT
    id,
    -- выбираем имя
    first_name,
    -- выбираем фамилию
    last_name,
    -- тут условие что это админ
    IF(role = 'admin', 1, 0) AS is_admin
FROM 
    users
;

Обратите внимание, что для комментирования с помощью двойного тире -- необходимо добавить пробел после.

Но не обязательно добавлять пробел, если вы используете для комментария символ #.

Вы также можете добавить инлайн-комментарий, используя символ прямой косой черты и звездочки (/*), за которым следует закрывающий тег звездочки и прямой косой черты (*/) следующим образом:

/* Это также допустимый комментарий MySQL */

Подобный комментарий можно поместить в середину запроса, как показано ниже:

SELECT id, first_name /* , last_name */ FROM users;

Приведенный выше запрос можно выполсить и в результате получим только колонки id и first_name, игнорируя столбец last_name.

Вы также можете создать многострочный комментарий, используя прямую косую черту и символ звездочки следующим образом:

/* 
 * Author: Fomenko Alexander
 * Date: 25.11.2021
 *
 * Это какой-то запрос для каких-то там пользователей
 */

SELECT * FROM users;

Многострочный комментарий обычно используется для информирования разработчиков о спецификации .sql файла запроса.

Ну вот, теперь вы знаете как можно писать комментарии в MySQL 😉.