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

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

Немного комментариев для таблиц в MSSQL

Привет Хабр!
Некоторые из нас пишут и/или поддерживают БД на основе СУБД MSSQL 20xx. Я такими развлечениями занимаюсь давно, и как-то потихоньку я для себя решил писать комментарии к таблицам и столбцам, как к своим так и к чужим. Это оказалось удобно, благодаря тому, что всегда можно увидеть зачем “это” было сделано, и как “это” кушать. Единственным неудобным моментом является написание этих самых комментариев, ибо в MS SQL для этого нужно создавать строчки типа:

Как-то много кода для простой операции, а иных, более лёгких способов я не нашел. Немного подумав, я решил создать простую процедуру для добавления комментариев.

Разумеется я ленив

Спасибо за внимание.
PS: Если вы знаете более простые способы решения описанных выше проблем с комментариями в SQL буду рад прочитать о них в комментариях.

SQL Comments

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

Примечание: примеры в этой главе не будут работать в Firefox и Microsoft Edge!

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

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

Комментарии одной строки начинаются с—.

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

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

Пример

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

Пример

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

Пример

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

Multi-line comments start with /* and end with */.

Any text between /* and */ will be ignored.

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

Пример

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

Пример

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

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

Пример

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

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

COMMENT — задать или изменить комментарий объекта

Синтаксис

Описание

COMMENT сохраняет комментарий об объекте базы данных.

Для каждого объекта сохраняется только одна строка, так что для изменения комментария нужно просто выполнить COMMENT ещё раз для того же объекта. Чтобы удалить комментарий, вместо текстовой строки укажите NULL . При удалении объектов комментарии удаляются автоматически.

Для большинства типов объектов комментарий может установить только владелец объекта. Но так как роли не имеют владельцев, COMMENT ON ROLE для ролей суперпользователей разрешено выполнять только суперпользователям, а для обычных ролей — тем, кто имеет право CREATEROLE . Так же не имеют владельцев и методы доступа; чтобы добавить комментарий для метода доступа, нужно быть суперпользователем. Разумеется, суперпользователи могут задавать комментарии для любых объектов.

Просмотреть комментарии можно в psql , используя семейство команд \d . Имеется возможность получать комментарии и в других пользовательских интерфейсах, используя те же встроенные функции, что использует psql , а именно obj_description , col_description и shobj_description (см. Таблицу 9.68).

Параметры

Имя объекта, для которого задаётся комментарий. Имена таблиц, агрегатных функций, правил сортировки, перекодировок, доменов, сторонних таблиц, функций, индексов, операторов, классов и семейств операторов, процедур, последовательностей, подпрограмм, объектов текстового поиска и статистики, типов и представлений могут быть дополнены именем схемы. При определении комментария для столбца, имя_отношения должно ссылаться на таблицу, представление, составной тип или стороннюю таблицу. имя_таблицы
имя_домена

При создании комментария для ограничения, триггера, правила или политики эти параметры задают имя таблицы или домена, к которым относится этот объект. исходный_тип

Имя исходного типа данных для приведения. целевой_тип

Имя целевого типа данных для приведения. режим_аргумента

Режим аргумента функции, процедуры или агрегата: IN , OUT , INOUT или VARIADIC . По умолчанию подразумевается IN . Заметьте, что COMMENT не учитывает аргументы OUT , так как для идентификации функции нужны только типы входных аргументов. Поэтому достаточно перечислить только аргументы IN , INOUT и VARIADIC . имя_аргумента

Имя аргумента функции, процедуры или агрегата. Заметьте, что на самом деле COMMENT не обращает внимание на имена аргументов, так как для однозначной идентификации функции достаточно только типов аргументов. тип_аргумента

Тип данных аргумента функции, процедуры или агрегата. oid_большого_объекта

OID большого объекта. тип_слева
тип_справа

Тип данных аргументов оператора (возможно, дополненный именем схемы). В случае отсутствия аргумента префиксного или постфиксного оператора укажите вместо типа NONE . PROCEDURAL

Это слово не несёт смысловой нагрузки. имя_типа

Имя типа данных, для которого предназначена трансформация. имя_языка

Имя языка, для которого предназначена трансформация. текст

Новый комментарий, записанный в виде строковой константы (или NULL для удаления комментария).

Замечания

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

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)

Нагулено тут по запросу “

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

INSERT INTO t VALUES (1, 'Hello, world'), (2, 'abc'), (3, 'def')

SELECT $smth$SHOW CREATE VIEW my_view$smth$;

┌─'SHOW CREATE VIEW my_view'─┐
│ SHOW CREATE VIEW my_view   │
└────────────────────────────┘

expr AS alias

CREATE TABLE t
(
a Int,
b Int
)
ENGINE = TinyLog()

SELECT
argMax(a, b),
sum(b) AS b
FROM t

Received exception from server (version 18. 14.17):
Code: 184. DB::Exception: Received from localhost:9000, 127.0.0.1. DB::Exception: Aggregate function sum(b) is found inside another aggregate function in query.

-- Допустимые строковые и шестнадцатеричные константы
'Санкт-Петербург'
"Простая строка"
'8910'
'Корректная строка с апострофом - I can''t'
0xCD1F

-- Недопустимые строковые константы

'AB'CD'             -- нечетное число одинарных кавычек
'Санкт-Петербург"   -- строка должна быть заключена в одинаковые кавычки, 
                    -- т. е. одинарные или двойные с каждого конца строки

160
-160.00
-0.2357E5     -- экспоненциальное представление, где nEm 
              -- означает n умножено на 10 в степени m
43. 3E-4

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

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

В этой статье будут даны советы по комментированию кода 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]
 ВНУТРЕННЕЕ СОЕДИНЕНИЕ [Человек].[Человек] стр. 

Комментариями можно управлять с помощью ApexSQL Refactor. В окне Параметры на вкладке Комментарии есть различные параметры для управления комментариями:

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

До:

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

После:

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

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

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

Комментарии блока можно настроить, добавив границы с помощью Добавить границу над комментариями блока с помощью <настраиваемого знака> и Добавить границу под комментариями блока с помощью <настраиваемого знака> 9Варианты 0004:

До:

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

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

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

После:

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

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

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

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

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

Раньше:

 ИСПОЛЬЗОВАТЬ 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
ВПЕРЕД 

Ссылки:
[1] Электронная документация по SQL Server — с использованием комментариев

Полезные ресурсы:
Электронная документация по SQL Server — /*…*/ (Комментарий) (Transact-SQL)
Электронная документация по SQL Server — — ( Comment) (Transact-SQL)
Электронная документация по SQL Server — Комментарии

12 февраля 2014 г.

Комментарии PL/SQL — улучшение читаемости кода PL/SQL

Резюме : в этом руководстве вы узнаете, как использовать комментарии PL/SQL, включая однострочные и многострочные комментарии, которые позволяют вам улучшить читаемость вашего кода.

Введение в комментарии PL/SQL

Комментарии PL/SQL позволяют описать назначение строки или блока кода PL/SQL.

При компиляции кода PL/SQL прекомпилятор Oracle игнорирует комментарии. Тем не менее, вы всегда должны использовать комментарии, чтобы сделать ваш код более читабельным и помочь вам и другим разработчикам лучше понять его в будущем.

PL/SQL имеет два стиля комментариев: однострочные и многострочные комментарии.

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

Однострочные комментарии начинаются с двойного дефиса ( -- ), которые могут появляться в любом месте строки и доходить до конца строки.

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

 
  -- налог на добавленную стоимость 10%
DECLARE co_vat_rate ПОСТОЯННОЕ ЧИСЛО := 0,1;
  
  Язык кода: SQL (язык структурированных запросов) (sql)  

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

 
  -- ОБНОВИТЬ продукты SET list_price = 0 WHERE product_id = l_id;
  
  Язык кода: SQL (язык структурированных запросов) (sql)  

Если вы хотите прокомментировать только часть строки, вы также можете использовать однострочный комментарий. В следующем примере показано, как закомментировать предложение WHERE оператора UPDATE . Весь код, который следует за двойным дефисом -- до конца строки, будет рассматриваться как комментарий:

 
  ОБНОВЛЕНИЕ продуктов SET list_price = 0; -- ГДЕ product_id = l_id;
  
  Язык кода: SQL (язык структурированных запросов) (sql)  

Обратите внимание, что мы добавляем точку с запятой ( ; ) перед ( -- ), чтобы сделать оператор действительным.

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

Многострочный комментарий начинается с косой черты ( /* ) и заканчивается звездочкой ( */ ) и может занимать несколько строк:

 
  /*
  Это многострочный комментарий
  который может занимать несколько строк
*/
  
  Язык кода: SQL (язык структурированных запросов) (sql)  

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

 
  /* Многострочный комментарий можно используется как однострочный комментарий */
  
  Язык кода: SQL (язык структурированных запросов) (sql)  

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

 
  /*
    Этот код позволяет пользователям вводить идентификатор клиента и
    вернуть соответствующее имя клиента и кредитный лимит
*/
ЗАЯВИТЬ
    l_customer_name customers. name%TYPE;
    l_credit_limit клиентов.credit_limit%TYPE;
НАЧИНАТЬ
   ...
КОНЕЦ;
/
  
  Язык кода: SQL (язык структурированных запросов) (sql)  

Для удобства сопровождения не рекомендуется смешивать комментарии следующим образом:

 
  НАЧАЛО
    -- однострочный комментарий /* другой комментарий */
    НУЛЕВОЙ;
    /*
        многострочный комментарий
        -- с еще одним однострочным комментарием
    */
КОНЕЦ;
/
  
  Язык кода: SQL (язык структурированных запросов) (sql)  

Вместо этого используйте следующее:

 
  НАЧАЛО
    -- однострочный комментарий, еще один комментарий
    НУЛЕВОЙ;
    /*
        многострочный комментарий
        который имеет еще один однострочный комментарий
    */
КОНЕЦ;
/
  
  Язык кода: SQL (язык структурированных запросов) (sql)  

Замечания по использованию комментариев PL/SQL

PL/SQL не позволяет вкладывать многострочный комментарий в другой многострочный комментарий. Следующий кодовый блок недействителен:

 
  НАЧАЛО
    /*
        многострочный комментарий
        /*
            вложенный многострочный комментарий
        */
    */ -- -> ошибка
КОНЕЦ;
/
  
  Язык кода: SQL (язык структурированных запросов) (sql)  

Для блока PL/SQL, который будет обрабатываться динамически, нельзя использовать однострочные комментарии. Поскольку прекомпилятор Oracle будет игнорировать символы конца строки, из-за которых однострочные комментарии расширяются до конца блока. В этом случае вместо этого вы можете использовать многострочные комментарии.

Из этого руководства вы узнали о комментариях PL/SQL, включая однострочные и многострочные комментарии, которые позволяют документировать назначение вашего кода.

Было ли это руководство полезным?

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

Оператор комментариев SQL

Оператор комментариев SQL

Оператор комментариев SQL может упростить чтение и обслуживание вашего приложения. За Например, мы можем включить комментарий в оператор, описывающий цель утверждения в вашем приложении, за исключением подсказки, комментарии в SQL. Оператор не влияет на выполнение оператора. Пожалуйста, обратитесь к подсказкам по использованию этой конкретной формы комментария.

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

• Начинайте комментарий с косой черты и звездочки (/*). Перейдите к тексту комментария. Этот текст может занимать несколько строк.

• Завершите комментарий звездочкой и косой чертой (*/). Открывающие и завершающие символы не нужно отделять от текста пробелом или разрывом строки.

• Начинайте комментарий с — (два дефиса). Перейдите к тексту комментария. Этот текст не может распространяться на новую строку. Завершите комментарий разрывом строки.

Некоторые инструменты, используемые для ввода SQL, имеют дополнительные ограничения. Например, если вы используете SQL*plus, по умолчанию у вас не может быть пустой строки внутри многострочного комментария.

Для получения дополнительной информации см. документацию по инструменту, который вы используете в качестве интерфейса к базе данных. Оператор SQL может содержать несколько комментариев обоих стилей. Текст комментария может содержать любые печатные символы из набора символов вашей базы данных.

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

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

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

Синтаксис 

1. — text_of_comment

Примеры

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

Синтаксис

1. — Выберите образец базы данных.
образец ЕГЭ
2. ;
3. GO      
4. — Выберите все столбцы и все строки из таблицы Адреса.
5. ВЫБОР *      
6. ОТ Сведения о заказе      
7. ORDER BY OrderId  ASC; — Нам не обязательны указывать ASC, поскольку       
8.  — значение по умолчанию.

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

Однострочные комментарии начинаются с —. Любой текст между — и концом строки будет проигнорирован (не будет выполнен). В следующем примере в качестве пояснения используется однострочный комментарий.

Синтаксис  

1. —Выбрать все:    
2. SELECT * FROM OrderDetails ;

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

Синтаксис 

1. SELECT * FROM OrderDetails — WHERE OrderName=’Coffee’;

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

Синтаксис 

1. —SELECT * FROM OrderDetails;
2. SELECT * FROM OrderDetails ;

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

Многострочные комментарии SQL начинаются с /* и заканчиваются */. Любой текст между /* и */ будет игнорироваться. В следующем примере в качестве пояснения используется многострочный комментарий.

Синтаксис   

1. /*Выбрать все столбцы    
2. всех записей    
3. в таблице OrderDetails:*/    
4. SELECT * FROM OrderDetails;

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

Синтаксис 

1. /*SELECT * FROM Customers;
2. SELECT * FROM Products;
3. ВЫБРАТЬ * ИЗ Заказов;
4. ВЫБЕРИТЕ * ИЗ Категорий;*/    
5. SELECT * FROM OrderDetails;

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

Синтаксис  

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

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

Синтаксис 

1. SELECT * FROM OrderDetails WHERE (OrderName LIKE ‘L%’    
2. ИЛИ OrderName LIKE ‘R%’ /*OR OrderName  LIKE ‘S%’    
3. ИЛИ OrderName LIKE ‘T%’*/ ИЛИ OrderName LIKE ‘W%’)    
4. И ИмяЗаказа =’Манго’    
5. ORDER BY OrderrAddress;

Сводка

В этой статье вы узнали, как использовать инструкцию комментариев SQL с различными параметрами.

• комментарий sql
• оператор комментария
• оператор комментариев SQL

Как вводить комментарии SQL

Как вводить комментарии SQL

Руководство Informix по SQL: синтаксис Обзор синтаксиса SQL

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

Ваши комментарии могут помочь вам или другим понять роль оператора в программе, процедуре SPL или командном файле. Примеры кода в этом руководстве иногда содержат комментарии, разъясняющие роль оператора SQL в коде.

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

Символ комментария	ESQL/C	Стандарт SPL	БД-доступ	ANSI-совместимые базы данных	Базы данных , которые не соответствуют стандарту ANSI	Описание
двойное тире (—)	Д	Д	Д	Д	Д	Двойное тире предшествует комментарию. Двойной тире может комментировать только одну строку. Чтобы прокомментировать более одной строки, вы должны поставить двойное тире в начале каждой строки комментария.
фигурные скобки ({})	Н	Д	Д	Д	Д	Скобки заключают комментарий. { предшествует комментарию, а } следует за комментарием. Вы можете использовать фигурные скобки для однострочных или многострочных комментариев. Комментарии не могут быть вложенными.

Если продукт, который вы используете, поддерживает оба символа комментария, выбор символа комментария зависит от ваших требований к соответствию ANSI :

• Двойной тире (—) соответствует стандарту ANSI SQL.
• Фигурные скобки ({}) являются расширением стандарта Informix.

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

В DB-Access вы можете использовать любой символ комментария при вводе операторов SQL с помощью редактора SQL и при создании командных файлов SQL с помощью редактора SQL или системного редактора. Командный файл SQL — это файл операционной системы, содержащий один или несколько операторов SQL. Командные файлы также известны как командные сценарии. Дополнительные сведения о командных файлах см. в обсуждении командных сценариев в Informix Guide to SQL : Tutorial . Для получения информации о том, как создавать и изменять командные файлы с помощью редактора SQL или системного редактора в DB-Access, см.0027 БД — Доступ к Руководству пользователя .

Вы можете использовать любой символ комментария в любой строке подпрограммы SPL . См. обсуждение того, как комментировать и документировать подпрограмму SPL в Informix Guide to SQL : Tutorial .

В ESQL/C вы можете использовать двойное тире (—) для комментирования операторов SQL. Для получения дополнительной информации об использовании символов комментариев SQL и символов комментариев для конкретных языков в программах ESQL/C см.0027 Informix ESQL/C Руководство программиста .

Примеры символов комментариев SQL

Несколько простых примеров могут помочь проиллюстрировать различные способы использования символов комментариев SQL.

Примеры символа двойного тире

В следующем примере показано использование двойного тире (—) для комментирования инструкции SQL. В этом примере комментарий отображается в той же строке, что и оператор.

SELECT * FROM customer -- выбирает все столбцы и строки

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

SELECT * FROM customer
-- Выбирает все столбцы и строки

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

SELECT * FROM customer
-- Выбирает все столбцы и строки
-- из таблицы клиентов

Примеры символов скобок

В следующем примере показано использование фигурных скобок ({}) для комментирования инструкции SQL. В этом примере комментарий отображается в той же строке, что и оператор.

SELECT * FROM customer {Выбирает все столбцы и строки}

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

SELECT * FROM customer
{Выбирает все столбцы и строки}

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

SELECT * FROM customer
{Выбирает все столбцы и строки
из таблицы клиентов}

Символы, отличные от ASCII, в комментариях SQL

Вы можете вводить не- символов ASCII (включая многобайтовые символы) в комментариях SQL, если ваша локаль поддерживает набор кодов с не- символами.0723 ASCII символов. Для получения дополнительной информации об аспектах GLS комментариев SQL см. Informix Guide to GLS Functionality .

---

Руководство Informix по SQL: синтаксис , версия 9.2
Copyright 1999, Informix Software, Inc. Все права защищены.

Удаление комментариев из кода T-SQL

Удаление комментариев из запроса T-SQL может оказаться непростой задачей, особенно если запрос длинный и содержит несколько разделов и блоков встроенных комментариев.

Комментирование кода для объяснения того, что этот раздел должен делать. Источник: Microsoct Docs

Эта процедура удалит все комментарии из вашего запроса T-SQL и вернет только те части, которые не закомментированы.

Процедура способна обнаруживать и удалять следующие типы комментариев (независимо от позиции кода или комментария):

• встроенный комментарий ( — комментарии )
• многострочный комментарий (косая звездочка /* комментарии)
• встроенный блок комментариев
• комментарий внутри комментария (многострочный блок)

Например, такой запрос:

СОЗДАТЬ ИЛИ ИЗМЕНИТЬ ПРОЦЕДУРУ [dbo]. [sql_sample_procedure]
В КАЧЕСТВЕ
НАЧИНАТЬ
-- Запрос
/*********************
Это наш запрос
        С автором, датой и местом
*******************/
---- Добавление комментариев
ВЫБРАТЬ
s.Name
,s.Фамилия
-- ,s.Фамилия
,d.DepartmentName -- Комментарий
-- Комментарий здесь
-- /*,d.DepartmentID*/
/* Это комментарий */ -- работает
---------------------
/* это встроенный комментарий
в две строки */
/* /* это двойной комментарий */*/ -- работает
,'тест' AS-тест
/* /* комментарий */*/ --nope
ОТ Студентов AS s
ПРИСОЕДИНЯЙТЕСЬ к отделам AS D
ON d.DepartmentId = s.DepartmentId
КОНЕЦ;
ИДТИ
 

будет преобразован (удален и удалены все блоки комментариев) в:

СОЗДАТЬ ПРОЦЕДУРУ [dbo].[sql_sample_procedure]
В КАЧЕСТВЕ
НАЧИНАТЬ
  ВЫБРАТЬ
  s.Name
  ,s.Фамилия
  ,d.Название отдела
  ,'тест' AS-тест
  ОТ Студентов AS s
  ПРИСОЕДИНЯЙТЕСЬ к отделам AS D
  ON d.DepartmentId = s.DepartmentId
 КОНЕЦ;
 

Давайте рассмотрим код T-SQL для удаления комментариев с помощью процедуры. Мы рассмотрим два способа удаления комментариев; как процедура и как запрос T-SQL, передаваемый в качестве аргумента.

Создание процедуры удаления комментариев

Процедура удаления комментариев состоит из трех шагов:

1. Запуск EXEC sp_helptext для получения запроса T-SQL в перечисляемой таблице комментарии ; будь то в линию или в несколько строк.
2. Удаление однострочных комментариев — комментарии .

УДАЛИТЬ ТАБЛИЦУ, ЕСЛИ СУЩЕСТВУЕТ dbo.SQL_query_table;
СОЗДАТЬ ТАБЛИЦУ dbo.SQL_query_table (
     идентификатор INT IDENTITY (1,1) НЕ NULL
    ,query_txt NVARCHAR(4000)
)
ВСТАВИТЬ В dbo.SQL_query_table
EXEC sp_helptext
@objname = @имя_процедуры
ОБЪЯВИТЬ @proc_text varchar(8000) = ''
ОБЪЯВИТЬ @proc_text_row varchar(8000)
ОБЪЯВИТЬ @proc_no_comment varchar(8000) = ''
ОБЪЯВИТЬ @comment_count INT = 0
ВЫБЕРИТЕ @proc_text = @proc_text + CASE
КОГДА ДЛИН(@proc_text) > 0, ТО '\n'
ИНАЧЕ '' КОНЕЦ + query_txt
ИЗ dbo. SQL_query_table
ОБЪЯВИТЬ @i INT = 1
DECLARE @rowcount INT = (ВЫБЕРИТЕ ДЛИН(@proc_text))
ПОКА (@i <= @rowcount)
НАЧИНАТЬ
ЕСЛИ ПОДСТРОКА(@proc_text,@i,2) = '/*'
НАЧИНАТЬ
ВЫБЕРИТЕ @comment_count = @comment_count + 1
КОНЕЦ
ИНАЧЕ, ЕСЛИ ПОДСТРОКА(@proc_text,@i,2) = '*/'
НАЧИНАТЬ
ВЫБЕРИТЕ @comment_count = @comment_count - 1
КОНЕЦ
ИНАЧЕ, ЕСЛИ @comment_count = 0
ВЫБЕРИТЕ @proc_no_comment = @proc_no_comment + SUBSTRING(@proc_text,@i,1)
ЕСЛИ ПОДСТРОКА(@proc_text,@i,2) = '*/'
ВЫБЕРИТЕ @i = @i + 2
ЕЩЕ
ВЫБЕРИТЕ @i = @i + 1
КОНЕЦ
ПОКА (@i <= @rowcount)
НАЧИНАТЬ
ЕСЛИ ПОДСТРОКА(@proc_text,@i,4) = '/*/*'
НАЧИНАТЬ
ВЫБЕРИТЕ @comment_count = @comment_count + 2
КОНЕЦ
ИНАЧЕ, ЕСЛИ ПОДСТРОКА(@proc_text,@i,4) = '*/*/'
НАЧИНАТЬ
ВЫБЕРИТЕ @comment_count = @comment_count - 2
КОНЕЦ
ИНАЧЕ, ЕСЛИ @comment_count = 0
ВЫБЕРИТЕ @proc_no_comment = @proc_no_comment + SUBSTRING(@proc_text,@i,1)
ЕСЛИ ПОДСТРОКА(@proc_text,@i,4) = '*/*/'
ВЫБЕРИТЕ @i = @i + 2
ЕЩЕ
ВЫБЕРИТЕ @i = @i + 1
КОНЕЦ
УДАЛИТЬ ТАБЛИЦУ, ЕСЛИ СУЩЕСТВУЕТ #tbl_sp_no_comments
СОЗДАТЬ ТАБЛИЦУ #tbl_sp_no_comments (
rn INT IDENTITY(1,1)
,sp_text VARCHAR(8000)
)
ПОКА (LEN(@proc_no_comment) > 0)
НАЧИНАТЬ
ВСТАВИТЬ В #tbl_sp_no_comments (sp_text)
ВЫБРАТЬ ПОДСТРОКУ( @proc_no_comment, 0, CHARINDEX('\n', @proc_no_comment))

SELECT @proc_no_comment = SUBSTRING(@proc_no_comment, CHARINDEX('\n',@proc_no_comment) + 2, LEN(@proc_no_comment))
КОНЕЦ
УДАЛИТЬ ТАБЛИЦУ, ЕСЛИ СУЩЕСТВУЕТ #tbl_sp_no_comments_fin
СОЗДАТЬ ТАБЛИЦУ #tbl_sp_no_comments_fin
(rn_orig INT IDENTITY(1,1)
,rn INT
,sp_text_fin VARCHAR(8000))
DECLARE @nofRows INT = (ВЫБЕРИТЕ COUNT(*) FROM #tbl_sp_no_comments)
ОБЪЯВИТЬ @ii INT = 1
ПОКА (@nofRows >= @ii)
НАЧИНАТЬ
ОБЪЯВИТЬ @LastLB INT = 0
ОБЪЯВИТЬ @Com INT = 0
SET @Com = (SELECT CHARINDEX('--', sp_text,@com) FROM #tbl_sp_no_comments ГДЕ rn = @ii)
SET @LastLB = (SELECT CHARINDEX(CHAR(10), sp_text, @LastLB) FROM #tbl_sp_no_comments WHERE rn = @ii)
ВСТАВИТЬ В #tbl_sp_no_comments_fin (rn, sp_text_fin)
ВЫБРАТЬ
р-н
,СЛУЧАЙ, КОГДА @Com = 0, ТО sp_text
КОГДА @Com <> 0 THEN SUBSTRING(sp_text, 0, @Com) END as new_sp_text
ОТ #tbl_sp_no_comments
КУДА
рн = @ii
НАБОР @ii = @ii + 1
КОНЕЦ
 

После создания процедуры все, что вам нужно сделать, это запустить процедуру удаления комментариев:

 EXEC dbo.
No related posts.