Блог Vaden Pro

Все о самостоятельном создании и продвижении сайтов

Способы создания комментариев в MySQL

Дата:10.03.15 в 13:20
Раздел: 

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

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

Однострочные комментарии

  • # - символ решетки сообщает обработчику кода, что все символы содержащиеся в коде после него до конца строки являются комментарием.
    mysql> SELECT 1+1;     # Наши заметки
  • -- - также как и решетка скроет от обработки все, что идет после дефисов до конца строки.
    mysql> SELECT 1+1;     -- Наши заметки

Разница между данными типами комментариев заключается лишь в том, что после -- должен следовать хоть 1 пробел, чтобы все сработало корректно. После решетки же мы сразу можем писать все, что нам угодно.

Многострочные комментарии

Задается при помощи символов «/*» в начале комментария и «*/» в конце.

Таким образом мы можем не только скрывать несколько строк кода, а и создавать небольшие пометки для себя прямо посреди строки:

mysql> SELECT 1 /* Что-то что нужно не забыть */ + 1;
mysql> SELECT 1+
/*
Рассказ на несколько строк
о важных моментах в этом фрагменте кода
*/
1;

Все крайне просто, но как обычно есть свои нюансы:

  • Использовать символы «’» и «”» внутри многострочного комментария в MySQL не стоит, поскольку даже когда они скрыты в конструкцию «/*…*/» они будут считаны и расценены как границы отдельной строки в кавычках, что может привести к ошибкам в коде.
  • Не используйте также «;». Точка с запятой будет прочитана даже когда она находится в комментарии. Поскольку по синтаксису она обозначает конец команды все, что следует далее будет расценено как новое выражение не имеющее ничего общего с предыдущим.

Подводя итоги

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

Оценок: 1 (средняя 5 из 5)

Оценка: 
Ключевые слова: 
Понравилась статья? Расскажите о ней друзьям: