Как в SQL ставить комментарии: простой гид для начинающих

Чтобы оставить комментарий в SQL, вы можете использовать символ двойного дефиса (--) или символ звездочки (/* */).

Пример с использованием символа двойного дефиса:

-- Это комментарий
SELECT * FROM таблица;

Пример с использованием символов звездочки:

/* Это также комментарий */
SELECT * FROM таблица;

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

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

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

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

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

-- Это однострочный комментарий
SELECT * FROM users; -- Запрос для выборки всех пользователей из таблицы "users"
    

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

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

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

/*
  Это
  многострочный
  комментарий
*/
SELECT * FROM users;
    

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

Комментарии к структурам БД

В SQL часто возникает необходимость комментировать не только фрагменты кода, но и структуры баз данных, такие как таблицы, столбцы и ограничения. Для этого существуют специальные команды, зависящие от используемой СУБД.

Вот несколько примеров комментариев к структурам БД с использованием разных СУБД:

MySQL / MariaDB:

-- Комментарий для таблицы
CREATE TABLE users (
    id INT PRIMARY KEY, -- ID пользователя
    name VARCHAR(50) NOT NULL -- Имя пользователя
);
    

PostgreSQL:

-- Комментарий для таблицы
CREATE TABLE users (
    id INT PRIMARY KEY, -- ID пользователя
    name VARCHAR(50) NOT NULL -- Имя пользователя
);
COMMENT ON TABLE users IS 'Таблица для хранения информации о пользователях';
COMMENT ON COLUMN users.id IS 'Уникальный идентификатор пользователя';
COMMENT ON COLUMN users.name IS 'Имя пользователя';
    

SQL Server:

-- Комментарий для таблицы
CREATE TABLE users (
    id INT PRIMARY KEY, -- ID пользователя
    name VARCHAR(50) NOT NULL -- Имя пользователя
);
EXEC sys.sp_addextendedproperty 
    @name=N'MS_Description', 
    @value=N'Таблица для хранения информации о пользователях', 
    @level0type=N'SCHEMA',
    @level0name=N'dbo',
    @level1type=N'TABLE',
    @level1name=N'users';
EXEC sys.sp_addextendedproperty 
    @name=N'MS_Description', 
    @value=N'Уникальный идентификатор пользователя', 
    @level0type=N'SCHEMA',
    @level0name=N'dbo',
    @level1type=N'TABLE',
    @level1name=N'users',
    @level2type=N'COLUMN',
    @level2name=N'id';
EXEC sys.sp_addextendedproperty 
    @name=N'MS_Description', 
    @value=N'Имя пользователя', 
    @level0type=N'SCHEMA',
    @level0name=N'dbo',
    @level1type=N'TABLE',
    @level1name=N'users',
    @level2type=N'COLUMN',
    @level2name=N'name';
    

Способ комментирования структур БД может различаться в зависимости от СУБД, но в большинстве случаев существуют аналогичные команды, которые позволяют добавлять комментарии для улучшения читаемости и понимания базы данных.

Итоги

Комментарии в SQL играют важную роль в понимании и документировании кода. Однострочные комментарии начинаются с символов двух дефисов (--), а многострочные комментарии оформляются с использованием символов /* и */. Комментарии также могут быть добавлены к структурам баз данных с помощью специфических команд для каждой СУБД.

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