В программировании или написании сценариев комментирование помещает в код удобочитаемые описания. Это не влияет на работу кода. Как правило, комментарии включают описание кода. Правильное комментирование чрезвычайно важно для поддержки кода в долгосрочной перспективе. Кроме того, очень важно, будет ли код использоваться другими. Говорят, что хорошо документированный код так же важен, как и правильно работающий код.
MySQL использует SQL для работы с базами данных. Это руководство продемонстрирует, как писать комментарии в операторах MySQL.
Комментарии в MySQL
В MySQL доступны три типа команд. Они разделены своими символами.
Важно помнить, что MySQL не поддерживает вложенные комментарии.
Комментарий с помощью «-»
Поместив «-» в конец строки кода, вы можете разместить однострочный комментарий. Посмотрите следующий пример.
$ SELECT * from employees; - Комментарий в конце строки
Обратите внимание, что для написания комментария не требуется пробел после символа «-». Однако MySQL реализует эту функцию, чтобы избежать проблем с некоторыми запросами SQL. Например, этот запрос, скорее всего, вызвал бы проблему с этим типом комментариев, если бы не требовалось пробелов.
$ SELECT 100–1; - Пробел, чтобы не вызывать недоразумений
Если бы MySQL не требовал пробелов, результат был бы неожиданным.
Комментарий с помощью «#»
Это еще один тип комментария, который ставится в конце строки. Он действует аналогично разделу, продемонстрированному ранее. Например,
$ SELECT * from employees; # комментарий в конце строки
Комментирование в стиле C
Если у вас когда-либо был опыт работы с программированием на C, то вы знакомы с этим типом комментариев. Он начинается с «/*» и заканчивается «*/». Как и в C, комментарии могут занимать несколько строк.
/ * Быстрая коричневая лисица прыгает через ленивую собаку * / SELECT * from users;
Исполняемые комментарии
MySQL поддерживает еще один тип комментариев – комментарии, которые будут выполнены. Это интересная функция, которая улучшает переносимость между разными базами данных. Он позволяет встраивать коды, которые будет выполнять только MySQL, но не любое другое решение для базы данных.
Исполняемый комментарий обычно выглядит примерно так. Он включает комментирование в стиле C. Однако после «/*» он начинается с восклицательного знака (!).
$ /*! <mysql_specific_code> */
Реализуем это в исполняемом коде. В следующем коде MySQL вернет 5. Однако любой другой механизм базы данных вернет 10.
$ SELECT 5 /*! +1 */
Это комментирование также поддерживает указание версии MySQL, необходимой для запуска этого кода, в комментарии. В таком случае структура комментария будет выглядеть примерно так.
$ /*!##### <mysql_specific_code> */
Обратите внимание, что всего 5 цифр, которые описывают версию MySQL.
- Символ 1: описывает основную версию, например 5 или 8.
- Персонаж 2-3: описывает второстепенную версию.
- Символ 4-5: описывает уровень патча.
В следующем примере код комментария будет запущен только в том случае, если сервер MySQL v8.0.27.
$ SELECT 5 /*!80027 +1 */
Чтобы проверить текущую версию MySQL, выполните следующую команду.
$ mysql --version
Мы также можем получить версию MySQL из оболочки MySQL.
$ SHOW VARIABLES LIKE "%version%"
Последние мысли
В этой статье описаны все поддерживаемые форматы комментариев в MySQL. Он также демонстрирует их реализацию в запросах. В определенных ситуациях MySQL даже позволяет запускать код из комментариев.