В sql комментарии: Комментарии в SQL-коде. Однострочные и многострочные

Содержание

— (комментарий) (Transact-SQL) — SQL Server

Twitter

LinkedIn

Facebook

Адрес электронной почты

Статья

12/30/2022

Чтение занимает 2 мин

Область применения: SQL Server (все поддерживаемые версии) База данных SQL Azure Управляемый экземпляр SQL Azure Azure Synapse Analytics Analytics Platform System (PDW)

Обозначает текст комментария пользователя. Комментарии могут вставляться отдельной строкой, добавляться к концу командной строки языка Transact-SQL или инструкции Transact-SQL. Сервер не обрабатывает комментарий.

Соглашения о синтаксисе Transact-SQL

Синтаксис

-- text_of_comment

Примечание

Ссылки на описание синтаксиса Transact-SQL для SQL Server 2014 и более ранних версий, см. в статье Документация по предыдущим версиям.

Аргументы

text_of_comment
Строка, содержащая текст комментария.

Используйте два дефиса ( — ) для однострочных или вложенных комментариев. Комментарии, вставляемые с использованием символов — , завершаются новой строкой, которая задается символом возврата каретки (U+000A), символом перевода строки (U+000D) или сочетанием этих двух символов. Длина комментариев не ограничена. В следующей таблице перечислены сочетания клавиш, используемые для комментирования и раскомментирования текста.

Действие	Standard
Преобразование выделенного текста в комментарий	CTRL + K, CTRL + C
Снять комментарий с выделенного текста	CTRL + K, CTRL + U

Дополнительные сведения о сочетаниях клавиш см. в статье Сочетания клавиш среды SQL Server Management Studio.

Сведения о многострочных комментариях см. в статье Косая черта-звездочка (блок комментариев) (Transact-SQL).

Примеры

В следующем примере используются символы комментария —.

-- Choose the AdventureWorks2012 database.  
USE AdventureWorks2012;  
GO  
-- Choose all columns and all rows from the Address table.  
SELECT *  
FROM Person.Address  
ORDER BY PostalCode ASC; -- We do not have to specify ASC because   
-- that is the default.  
GO

См. также:

Язык управления потоком (Transact-SQL)

Как я могу комментировать в 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.

Комментарии SQL

❮ Предыдущий
Далее ❯

Комментарии SQL

Комментарии используются для объяснения разделов операторов SQL или для предотвращения выполнения
операторов SQL.

Примечание. Примеры в этой главе не будут работать в Firefox и
Майкрософт Эдж!

Комментарии не поддерживаются в базах данных Microsoft Access. В наших примерах Firefox и Microsoft Edge используют базу данных Microsoft Access.

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

Однострочные комментарии начинаются с -- .

Любой текст между — и концом строки будет проигнорирован (не будет выполнен).

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

Пример

—Выбрать все:
SELECT * FROM Customers;

Попробуйте сами »

В следующем примере однострочный комментарий игнорирует конец строки:

Пример

SELECT * FROM Customers — WHERE City=’Berlin’;

Попробуйте сами »

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

Пример

—SELECT * FROM Customers;
ВЫБЕРИТЕ * ИЗ продуктов;

Попробуйте сами »

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

Многострочные комментарии начинаются с /* и заканчиваются на
*/ .

Любой текст между /* и */ будет игнорироваться.

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

Пример

/*Выбрать все столбцы
всех записей
в таблице Customers:*/
SELECT * FROM Customers;

Попробуйте сами »

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

Пример

/*SELECT * FROM Customers;
ВЫБЕРИТЕ * ИЗ продуктов;
ВЫБЕРИТЕ * ИЗ заказов;
SELECT * FROM Categories;*/
SELECT * FROM Suppliers;

Попробуйте сами »

Чтобы игнорировать только часть оператора, также используйте комментарий /* */.

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

Пример

SELECT CustomerName, /*City,*/ Country FROM Customers;

Попробуйте сами »

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

Пример

SELECT * FROM Customers WHERE (CustomerName LIKE ‘L%’
OR CustomerName LIKE ‘R%’ /*OR CustomerName LIKE ‘ S%’
ИЛИ CustomerName LIKE ‘T%’*/ ИЛИ CustomerName LIKE ‘W%’)
AND Country=’USA’
ЗАКАЗАТЬ ПО CustomerName;

Попробуйте сами »

❮ Предыдущая
Следующий ❯

ВЫБОР ЦВЕТА

Лучшие учебники

Учебник по HTML
Учебник по CSS
Учебник по JavaScript
Учебник How To
Учебник по SQL
Учебник по Python
Учебник по W3.CSS
Учебник по Bootstrap
Учебник по PHP
Учебник по Java
Учебник по C++
Учебник по jQuery

900 Справочник
Справочник по HTML
Справочник по CSS
Справочник по JavaScript
Справочник по SQL
Справочник по Python
Справочник по W3. CSS
Справочник по Bootstrap
Справочник по PHP
Цвета HTML
Справочник по Java
Справочник по Angular
Справочник по jQuery

1 Top1 Examples

Примеры HTML
Примеры CSS
Примеры JavaScript
Примеры инструкций
Примеры SQL
Примеры Python
Примеры W3.CSS
Примеры Bootstrap
Примеры PHP
Примеры Java
Примеры XML
Примеры jQuery

ФОРУМ |
О

W3Schools оптимизирован для обучения и обучения. Примеры могут быть упрощены для улучшения чтения и обучения.
Учебники, ссылки и примеры постоянно пересматриваются, чтобы избежать ошибок, но мы не можем гарантировать полную правильность всего содержания.
Используя W3Schools, вы соглашаетесь прочитать и принять наши условия использования,
куки-файлы и политика конфиденциальности.

SQL Server: комментарии в SQL

В этом учебном пособии по SQL Server объясняется, как использовать комментарии в операторах SQL в SQL Server (Transact-SQL) с синтаксисом и примерами.

Описание

Знаете ли вы, что вы можете размещать комментарии в своих операторах SQL в SQL Server (Transact-SQL)? Эти комментарии могут располагаться в одной строке или занимать несколько строк. Давайте посмотрим, как это сделать.

Синтаксис

Существует два синтаксиса, которые можно использовать для создания комментария в операторе SQL в SQL Server (Transact-SQL).

Синтаксис с использованием символа

--

Синтаксис для создания комментария SQL с использованием символа -- в SQL Server (Transact-SQL):

 --  комментарий идет сюда

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

Синтаксис с использованием

/* и */ символов

Синтаксис для создания комментария SQL с использованием /* и */ символов в SQL Server (Transact-SQL):

 /*  комментарий идет здесь  */

В SQL Server комментарий, начинающийся с символа /* и заканчивающийся на */ , может находиться в любом месте оператора SQL. Этот метод комментирования может занимать несколько строк в вашем SQL.

Пример — Комментарий к одной строке

Вы можете создать комментарий SQL в одной строке оператора SQL в SQL Server (Transact-SQL).

Давайте посмотрим на пример комментария SQL, который показывает комментарий SQL в отдельной строке:

 SELECT employee_id, last_name
/* Автор: TechOnTheNet.com */
ОТ сотрудников;

Вот комментарий SQL, который появляется в середине строки:

 SELECT /* Author: TechOnTheNet.com */ employee_id, last_name
ОТ сотрудников;

Вот комментарий SQL, который появляется в конце строки:

 SELECT employee_id, last_name /* Автор: TechOnTheNet.com */
ОТ сотрудников;

или

 ВЫБЕРИТЕ employee_id, last_name -- Автор: TechOnTheNet.com
ОТ сотрудников;

Пример — комментарий к нескольким строкам

В SQL Server (Transact-SQL) вы можете создать комментарий SQL, который занимает несколько строк в инструкции SQL.