• Artigo

Comentários

Os comentários são cadeias de caracteres de texto não executáveis em código de programa, também conhecidos como observações. Os comentários podem ser utilizados para documentar códigos ou desabilitar temporariamente partes de instruções Transact-SQL e lotes que estão sendo diagnosticados. A utilização de comentários para documentar códigos facilita a manutenção de códigos posterior. Frequentemente, são utilizados comentários para registrar o nome do programa, o nome do autor e as datas de alterações de código principais. Os comentários podem ser utilizados para descrever cálculos complexos ou explicar um método de programação.

O SQL Server oferece suporte a dois tipos de caracteres de comentário:

  • -- (hífens duplos). Esses caracteres de comentário podem ser utilizados na mesma linha que o código a ser executado, ou em uma linha específica. Tudo que estiver a partir dos hífens duplos até o final da linha faz parte do comentário. Para um comentário de várias linhas, os hífens duplos deverão ser exibidos na frente de cada linha de comentário. Para obter mais informações sobre como utilizar os caracteres de comentário, consulte -- (Comentário) (Transact-SQL).

  • /* ... */ (barra, asterisco, pares de caracteres). Esses caracteres de comentário podem ser utilizados na mesma linha que o código a ser executado, em linhas específicas ou mesmo dentro de um código executável. Tudo que estiver a partir do par de comentários de abertura (/*) até o par de comentários de fechamento (*/) faz parte do comentário. Para um comentário de várias linhas, o par de caracteres de comentário de abertura (/*) deve iniciar o comentário e o par de caracteres de comentário de fechamento (*/) deve terminar o comentário. Para obter mais informações sobre como utilizar os caracteres de comentário /* ..., consulte/*...*/ (Comentário) (Transact-SQL).

Considerações

Essas são algumas informações básicas sobre comentários:

  • Todos os caracteres alfanuméricos ou símbolos podem ser utilizados dentro do comentário. O SQL Server ignora todos os caracteres dentro de um comentário, embora o Editor de Códigos do SQL Server Management Studio e o sqlcmd pesquisem GO como os dois primeiros caracteres em linhas dentro de um comentário de várias linhas.

  • Não há um comprimento máximo para um comentário dentro de um lote. Um comentário pode conter uma ou mais linhas.

Exemplos

A seguir são exibidos alguns exemplos de comentários válidos.

USE AdventureWorks2008R2;
GO
-- Single line comment.

SELECT BusinessEntityID, 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 BusinessEntityID, /* FirstName, */ LastName
FROM Person.Person;

-- Using a comment after the code on a line.
USE AdventureWorks2008R2;
GO
UPDATE Production.Product
SET ListPrice = ListPrice * .9; -- Reduce price to build market share.
GO