Комментарии
Комментарии представляют собой неисполняемые текстовые строки в программном коде, также известные как примечания. Комментарии могут быть использованы для документирования кода или для временного выключения частей диагностируемых инструкций Transact-SQL и пакетов. Использование комментариев для документирования кода облегчает обслуживание программного кода в будущем. Комментарии часто используются для записи имени программы, имени автора и дат внесения в код существенных изменений. Комментарии могут быть использованы для описания сложных вычислений или объяснения метода программирования.
SQL Server 2005 поддерживает два типа символов выделения комментариев.
- -- (двойной дефис). Эти символы комментария могут находиться в той же строке, что и исполняемый программный код, или в отдельных строках. Все, что расположено после двойного дефиса и до конца строки, является частью комментария. В многострочных комментариях двойной дефис необходимо указывать в начале каждой строки комментария. Дополнительные сведения об использовании символов выделения комментариев см. в разделе -- (Комментарий) (Transact-SQL).
- /* ... */ (комбинации символов «косая черта-звездочка»). Эти символы комментария могут находиться в той же строке, что и исполняемый программный код, или в отдельных строках, или даже внутри исполняемого кода. Все, что расположено после комбинации символов, открывающей комментарий (/*), и до комбинации символов, закрывающей комментарий (*/), рассматривается как часть комментария. Для многострочного комментария комбинация символов, открывающая комментарий (/*), должна располагаться в начале комментария, а комбинацией символов, закрывающей комментарий (*/), комментарий должен оканчиваться. Дополнительные сведения об использовании символов выделения комментариев /* ... */ см. в разделе /*...*/ (комментарий) (Transact-SQL).
Замечания
Ниже приведены некоторые основные сведения о комментариях:
- Внутри комментария можно использовать все алфавитно-цифровые знаки или символы. SQL Server пропускает все символы внутри комментария, хотя редактор кода среды SQL Server Management Studio и команда sqlcmd будут искать команду GO в двух первых символах каждой строки внутри многострочного комментария.
- Длина комментария в пакете не ограничивается. Комментарий может содержать одну или несколько строк.
Примеры
Ниже приведены некоторые образцы правильных комментариев.
USE AdventureWorks;
GO
-- Single line comment.
SELECT EmployeeID, Title
FROM HumanResources.Employee;
GO
/* First line of a multiple-line comment.
Second line of a multiple-line comment. */
SELECT Name, ProductNumber, Color
FROM Production.Product;
GO
-- Using a comment in a Transact-SQL statement
-- during diagnosis.
SELECT ContactID, /* FirstName, */ LastName
FROM Person.Contact;
-- Using a comment after the code on a line.
USE AdventureWorks;
GO
UPDATE Production.Product
SET ListPrice = ListPrice * .9; -- Reduce price to build market share.
GO
См. также
Другие ресурсы
-- (Комментарий) (Transact-SQL)
/*...*/ (комментарий) (Transact-SQL)