Sql комментарии в коде: SQL комментарии — Oracle PL/SQL •MySQL •MariaDB •SQL Server •SQLite

Как я могу комментировать в MySQL?

В программировании или написании сценариев комментирование помещает в код удобочитаемые описания. Это не влияет на работу кода. Как правило, комментарии включают описание кода. Правильное комментирование чрезвычайно важно для поддержки кода в долгосрочной перспективе. Кроме того, очень важно, будет ли код использоваться другими. Говорят, что хорошо документированный код так же важен, как и правильно работающий код.

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 даже позволяет запускать код из комментариев.

Если вы нашли ошибку, пожалуйста, выделите фрагмент текста и нажмите Ctrl+Enter.

MSSQL: T-SQL – комментарии

Краткая заметка.

В T-SQL есть два варианта добавления коментариев – однострочные, и многострочные.

Однострочные комментарии начинаются с двух тире и заканчиваются новой строкой. Такой комментарий можно добавлять в любом месте кода, например – в конце строки с кодом. В таком случае всё, что указано до “--” будет выполнено как T-SQL запрос, а остальная часть строки – будет проигнорирована.

Пример:

1> select * from sys.databases -- Это комментарий
2> go
name    database_id     source_database_id      owner_sid       create_date     compatibility_level     collation_name  user_access     user_access_desc        is_read_only    is_auto_close_on        is_auto_shrink_on       state   state_desc      is_in_standby   is_cleanly_shutdown    is_supplemental_logging_enabled
...

Другой вариант – (“классические”) блочные комментарии. Они начинаются с символов “/*” и заканчиваются “*/“. Весь текст, заключённый между ними будет проигнорирован. Как правило – такие комментарии добавляют перед или после большого куска кода, но его можно поместить в любом месте. Кроме того – такой комментарий может заниматься несколько строк.

Пример:

1> /* Коммментарий
2> строка 2
3> */
4> select state_desc from sys.databases;
5> go
state_desc
ONLINE
ONLINE
ONLINE
ONLINE
ONLINE
(5 rows affected)

Нагулено тут по запросу “tsql comment block“.

More results…

Exact matches only

Exact matches only

Search in title

Search in title

Search in content

Search in content

Search in excerpt

Hidden

Hidden

Navigation

В этой статье будут даны советы по комментированию кода T-SQL и повышению производительности при использовании функции комментариев ApexSQL Refactor. ApexSQL Refactor — это надстройка форматирования SQL для SQL Server и Visual Studio с почти 200 параметрами форматирования.

Основная цель комментариев — документировать наш код и писать описания того, что он делает.

Использование комментариев в SQL Server

Microsoft SQL Server поддерживает два типа комментариев:

1. (–) — строчный комментарий. Его можно использовать в той же строке, что и код SQL, или в отдельной строке. Этот тип комментария начинается с двух тире и заканчивается возвратом каретки:

   .

    ИСПОЛЬЗОВАТЬ AdventureWorks2012
   ИДТИ
   ВЫБЕРИТЕ * ОТ HumanResources.Employee
   SELECT * FROM Person.Address -- Однострочный комментарий
   

   Для многострочных комментариев каждая строка должна начинаться с двух дефисов:

    ИСПОЛЬЗОВАТЬ AdventureWorks2012
   ИДТИ
   -- Первая строка многострочного комментария
   -- Вторая строка многострочного комментария
   ВЫБЕРИТЕ * ОТ HumanResources.Employee
   SELECT * FROM Person.Address -- Однострочный комментарий
   ВПЕРЕД 

2. (/*…*/) — блочный комментарий. Его можно использовать в той же строке, что и код SQL, в отдельной строке или в коде. Все, что находится между открывающей и закрывающей парой символов / *, считается частью комментария.

   Многострочные /* */ комментарии не могут охватывать пакет. Полный комментарий должен содержаться в пакете. Например, в SQL Query Analyzer и утилите sql команда GO сигнализирует об окончании пакета. Когда утилиты считывают символы GO в первых двух байтах строки, они отправляют весь код с момента последней команды GO на сервер как один пакет. Если GO возникает в начале строки между разделителями /* и */, то с каждым пакетом будет отправляться несопоставленный разделитель комментариев, что вызовет синтаксические ошибки. [1]

    ИСПОЛЬЗОВАТЬ AdventureWorks2012
   ИДТИ
   /* Первая строка многострочного комментария.
      Вторая строка многострочного комментария. */
   ВЫБЕРИТЕ * ОТ HumanResources.Employee
   SELECT * FROM Person.Address /*Однострочный комментарий*/
   ИДТИ
    

   Блочный код можно использовать в любом месте кода SQL:

    SELECT Дата рождения, /* Имя, */ Семейное положение
   ОТ HumanResources.
     Employee 

   Замена многострочного комментария однострочным приведет к синтаксической ошибке:

    ВЫБЕРИТЕ дату рождения, --FirstName, семейное положение
   ОТ HumanResources.Employee
   
   
   Сообщение 156, уровень 15, состояние 1, строка 2
   Неверный синтаксис рядом с ключевым словом FROM 

   .

Комментирование хранимых процедур в коде SQL

Рекомендуется начинать хранимую процедуру с комментария, в котором указывается как минимум автор, дата и история обновлений. После этого добавьте высокоуровневое описание функции этого модуля. Имя процедуры будет иметь формат «<глагол><объект>». Каждый параметр должен иметь комментарий по мере необходимости.

Пример комбинации однострочных и блочных комментариев:

 /*
Объект: хранимая процедура
Автор: Милица Медик
Дата сценария: 30 декабря 2013 г.
Описание: Эта процедура получает список адресов на основе
на значение города, которое передается в параметре @City
*/
СОЗДАТЬ ПРОЦЕДУРУ uspGetAddress @City nvarchar(30)
КАК
ВЫБРАТЬ *
ОТ AdventureWorks.  Person.Address
WHERE City = @City -- значение параметра @City сужает критерии поиска.
ИДТИ
 

Примеры комментирования частей хранимых процедур:

 НАЧАЛО
    УСТАНОВИТЬ БЕЗ СЧЕТА;
-- Используйте рекурсивный запрос, чтобы перечислить всех сотрудников, необходимых для конкретного менеджера.
    WITH [EMP_cte]([BusinessEntityID], [OrganizationNode], [FirstName], [LastName], [JobTitle], [RecursionLevel]) — имя и столбцы CTE
    КАК (
        SELECT e.[BusinessEntityID], e.[OrganizationNode], p.[FirstName],p.[LastName], e.[JobTitle], 0 -- Получить начального сотрудника
) 

Комментарии к оператору управления

Комментарии к оператору управления, такие как циклы IF-THEN-ELSE, BEGIN-END и WHILE-DO, будут очень похожи на комментарии в любой процедурной программе. Сложные операторы SQL могут потребовать комментария вверху и часто на уровне предложения:

 -- Возвращает имя, фамилию, должность и тип бизнес-объекта для указанного контакта.
-- Поскольку контакт может выполнять несколько ролей, может быть возвращено более одной строки. 
НАЧИНАТЬ
       ЕСЛИ @PersonID НЕ НУЛЬ
       НАЧИНАТЬ
       ЕСЛИ СУЩЕСТВУЕТ(ВЫБЕРИТЕ * FROM [HumanResources].[Employee] e
       ГДЕ e.[BusinessEntityID] = @PersonID)
       ВСТАВЬТЕ В @retContactInformation
       ВЫБЕРИТЕ @PersonID, p.FirstName, p.LastName, e.[JobTitle], «Сотрудник»
       ОТ [Отдел кадров].[Сотрудник] AS e
       ВНУТРЕННЕЕ СОЕДИНЕНИЕ [Человек].[Человек] p
       ON p.[BusinessEntityID] = e.[BusinessEntityID]
       ГДЕ e.[BusinessEntityID] = @PersonID;
       КОНЕЦ
ВОЗВРАЩАТЬСЯ;
КОНЕЦ; 

 -- Присоединиться обратно к Сотруднику, чтобы вернуть имя менеджера.
   ВЫБЕРИТЕ [EMP_cte].[RecursionLevel], [EMP_cte].[BusinessEntityID],[EMP_cte].[FirstName], [EMP_cte].[LastName], [EMP_cte]. [OrganizationNode].ToString() AS [OrganizationNode],
p.[FirstName] AS 'имя менеджера',
p.[LastName] AS 'ManagerLastName' -- Внешний выбор из CTE
 ОТ [EMP_cte]
 ВНУТРЕННЕЕ СОЕДИНЕНИЕ [Человеческие ресурсы].[Сотрудник] e
 ON [EMP_cte].[OrganizationNode].GetAncestor(1) = e.[OrganizationNode]
 ВНУТРЕННЕЕ СОЕДИНЕНИЕ [Человек].[Человек] стр. 

 ИСПОЛЬЗОВАТЬ AdventureWorks2012
ИДТИ
/* Первая строка многострочного комментария.
   Вторая строка многострочного комментария. */
ВЫБЕРИТЕ * ОТ HumanResources.Employee
SELECT * FROM Person. Address -- Однострочный комментарий
ВПЕРЕД 

 ИСПОЛЬЗОВАТЬ AdventureWorks2012
ИДТИ

/* Первая строка многострочного комментария.
   Вторая строка многострочного комментария. */

ВЫБЕРИТЕ * ОТ HumanResources.Employee
SELECT * FROM Person.Address -- Однострочный комментарий
GO 

 ИСПОЛЬЗОВАТЬ AdventureWorks2012
ИДТИ

/* Первая строка многострочного комментария.
   Вторая строка многострочного комментария. */

ВЫБЕРИТЕ * ОТ HumanResources.Employee
SELECT * FROM Person.Address /*Однострочный комментарий*/
GO 

 ИСПОЛЬЗОВАТЬ AdventureWorks2012
ИДТИ

/*********************************************
 Первая строка многострочного комментария. 
   Вторая строка многострочного комментария.
*********************************************/

ВЫБЕРИТЕ * ОТ HumanResources.Employee
SELECT * FROM Person.Address

/******************
Однострочный комментарий
******************/
ВПЕРЕД 

 ИСПОЛЬЗОВАТЬ AdventureWorks2012
ИДТИ
-- Первая строка многострочного комментария.
-- Вторая строка многострочного комментария.

ВЫБЕРИТЕ * ОТ HumanResources.Employee
SELECT * FROM Person.Address
 
--Однострочный комментарий

ИДТИ
 

 ИСПОЛЬЗОВАТЬ AdventureWorks2012
ИДТИ

/*********************************************
 Первая строка многострочного комментария.
   Вторая строка многострочного комментария. 
*********************************************/

ВЫБЕРИТЕ * ОТ HumanResources.Employee
SELECT * FROM Person.Address

/******************
Однострочный комментарий
******************/
ИДТИ
 

 ИСПОЛЬЗОВАТЬ AdventureWorks2012

ИДТИ
/*********************************************
 Первая строка многострочного комментария.
 Вторая строка многострочного комментария.
*******************************************/

ВЫБЕРИТЕ * ОТ HumanResources.Employee

SELECT * FROM Person.Address

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

ВПЕРЕД 

 ИСПОЛЬЗОВАТЬ AdventureWorks2012
ИДТИ
-- Первая строка многострочного комментария.
-- Вторая строка многострочного комментария.

ВЫБЕРИТЕ * ОТ HumanResources.Employee
SELECT * FROM Person. Address
 
--Однострочный комментарий

GO 

 ИСПОЛЬЗОВАТЬ AdventureWorks2012

ИДТИ
/*********************************************
 Первая строка многострочного комментария.
 Вторая строка многострочного комментария.
*******************************************/

ВЫБЕРИТЕ * ОТ HumanResources.Employee

SELECT * FROM Person.Address

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

GO 

 ИСПОЛЬЗОВАТЬ AdventureWorks2012

ИДТИ
ВЫБЕРИТЕ * ОТ HumanResources.Employee
SELECT * FROM Person.Address
ВПЕРЕД 

 ИСПОЛЬЗУЙТЕ AdventureWorks2012
ИДТИ
-- Первая строка многострочного комментария. 
-- Вторая строка многострочного комментария.
ВЫБЕРИТЕ * ОТ HumanResources.Employee
SELECT * FROM Person.Address -- Однострочный комментарий
GO 

 ИСПОЛЬЗОВАТЬ AdventureWorks2012
ИДТИ
ВЫБЕРИТЕ * ОТ HumanResources.Employee
SELECT * FROM Person.Address
ВПЕРЕД 

 -- text_of_comment