SQL comments: Como deixar co­men­tá­rios em códigos

SQL comments (co­men­tá­rios em SQL) podem ser usados para inserir anotações em códigos di­re­ta­mente. Existem três tipos prin­ci­pais de co­men­tá­rios:

SQL comments: Por que comentar em códigos?

Assim como em muitas outras lin­gua­gens de banco de dados e lin­gua­gens de pro­gra­ma­ção, a SQL (Struc­tu­red Query Language) oferece a pos­si­bi­li­dade de incluir co­men­tá­rios no código que são legíveis, mas não afetam a execução. Esses co­men­tá­rios podem ter vários pro­pó­si­tos. Eles podem ser usados para explicar áreas es­pe­cí­fi­cas do código. Se você ou outra pessoa precisar revisar ou continuar tra­ba­lhando no código mais tarde, os co­men­tá­rios podem fornecer in­for­ma­ções adi­ci­o­nais e ex­pli­ca­ções. Além disso, um co­men­tá­rio pode ser usado para desativar a execução de um comando SQL.

De­pen­dendo da in­ter­pre­ta­ção, co­men­tá­rios SQL podem ser divididos em duas ou três ca­te­go­rias:

• Single Line Comments (Co­men­tá­rios de linha única): Esses co­men­tá­rios começam e terminam na mesma linha do código. Eles começam com --.
• Multi Line Comments (Co­men­tá­rios de múltiplas linhas): Esses co­men­tá­rios abrangem várias linhas. Eles são iniciados com /* e ter­mi­na­dos com */.
• Inline Comments (Co­men­tá­rios em linha): Esses co­men­tá­rios são uma sub­ca­te­go­ria dos Multi Line Comments. Eles são usados entre duas ins­tru­ções e também são marcados com /* e */.

Co­men­tá­rios de linha única

Single Line Comments são exibidos com dois hífens con­se­cu­ti­vos. Tudo o que for escrito após esses hífens na mesma linha não será con­si­de­rado na execução. O fim do SQL comment coincide com o fim da linha. A partir do início da próxima linha, o código é executado nor­mal­mente novamente. Co­men­tá­rios de uma linha, portanto, não precisam ser en­cer­ra­dos ex­pli­ci­ta­mente com um caractere.

Para entender melhor o fun­ci­o­na­mento, veja um exemplo. No seguinte trecho de código, colocamos um co­men­tá­rio antes do comando SELECT, que descreve seu propósito.

-- Chamar todas as entradas da tabela Funcionários
SELECT *
FROM Funcionários;

Assim, apenas o código a partir de SELECT é con­si­de­rado.

Também é possível usar um co­men­tá­rio de linha única após uma instrução. A instrução e o co­men­tá­rio podem estar na mesma linha, desde que o co­men­tá­rio siga a instrução. Ao contrário, isso não é possível.

SELECT * -- selecione todos os registros
FROM Funcionários; -- considere a tabela chamada Funcionários

Co­men­tá­rios de múltiplas linhas

Co­men­tá­rios SQL que se estendem por várias linhas funcionam de maneira um pouco diferente. Eles precisam ter, obri­ga­to­ri­a­mente, um ponto de início e um ponto de término. Todo o texto entre esses dois pontos será ignorado durante a execução do código. No nosso exemplo acima, isso poderia ser feito da seguinte maneira:

/* Selecione todos os campos
em todas as linhas
da tabela inteira chamada Funcionários: */
SELECT *
FROM Funcionários;

Também é possível usar esses co­men­tá­rios para desativar a execução de uma de­ter­mi­nada instrução. Isso pode ser útil se você já tiver escrito essas ins­tru­ções, mas quiser ignorá-las tem­po­ra­ri­a­mente. Veja um exemplo apro­pri­ado:

/ *SELECT*  FROM Faturas;
SELECT * FROM Entradas de mercadorias;
SELECT * FROM Devoluções;
SELECT  *FROM Lista de Clientes;* /
SELECT * FROM Funcionários;

Embora tenhamos incluído cinco ins­tru­ções aqui, o sistema acessará apenas a tabela de Fun­ci­o­ná­rios. Faturas, Entradas de mer­ca­do­rias, De­vo­lu­ções e Lista de Clientes estão dentro do co­men­tá­rio e, portanto, são ignorados.

Co­men­tá­rios em linha

Inline Comments são um subtipo dos co­men­tá­rios Multi-Line regulares. Com um início e fim bem definidos, eles também podem ser inseridos entre as ins­tru­ções. É im­por­tante garantir que o fluxo de leitura não seja muito com­pro­me­tido. No entanto, se você deseja explicar um de­ter­mi­nado trecho de uma linha, os co­men­tá­rios em linha podem ser uma boa escolha. No exemplo simples a seguir, você verá como funciona um co­men­tá­rio desse tipo:

SELECT *
FROM / *Insira aqui o nome da tabela* / Funcionários;

O sistema exibirá sem res­tri­ções toda a tabela chamada “Fun­ci­o­ná­rios” e todas suas colunas e campos. O co­men­tá­rio é visível apenas para você ou para outro usuário do código.