SQL comments: Como deixar comentários em códigos

SQL comments (comentários em SQL) podem ser usados para inserir anotações em códigos diretamente. Existem três tipos principais de comentários:

SQL comments: Por que comentar em códigos?

Assim como em muitas outras linguagens de banco de dados e linguagens de programação, a SQL (Structured Query Language) oferece a possibilidade de incluir comentários no código que são legíveis, mas não afetam a execução. Esses comentários podem ter vários propósitos. Eles podem ser usados para explicar áreas específicas do código. Se você ou outra pessoa precisar revisar ou continuar trabalhando no código mais tarde, os comentários podem fornecer informações adicionais e explicações. Além disso, um comentário pode ser usado para desativar a execução de um comando SQL.

Dependendo da interpretação, comentários SQL podem ser divididos em duas ou três categorias:

• Single Line Comments (Comentários de linha única): Esses comentários começam e terminam na mesma linha do código. Eles começam com --.
• Multi Line Comments (Comentários de múltiplas linhas): Esses comentários abrangem várias linhas. Eles são iniciados com /* e terminados com */.
• Inline Comments (Comentários em linha): Esses comentários são uma subcategoria dos Multi Line Comments. Eles são usados entre duas instruções e também são marcados com /* e */.

Comentários de linha única

Single Line Comments são exibidos com dois hífens consecutivos. Tudo o que for escrito após esses hífens na mesma linha não será considerado 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 normalmente novamente. Comentários de uma linha, portanto, não precisam ser encerrados explicitamente com um caractere.

Para entender melhor o funcionamento, veja um exemplo. No seguinte trecho de código, colocamos um comentá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 é considerado.

Também é possível usar um comentário de linha única após uma instrução. A instrução e o comentário podem estar na mesma linha, desde que o comentá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

Comentários de múltiplas linhas

Comentários SQL que se estendem por várias linhas funcionam de maneira um pouco diferente. Eles precisam ter, obrigatoriamente, 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 comentários para desativar a execução de uma determinada instrução. Isso pode ser útil se você já tiver escrito essas instruções, mas quiser ignorá-las temporariamente. Veja um exemplo apropriado:

/ *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 instruções aqui, o sistema acessará apenas a tabela de Funcionários. Faturas, Entradas de mercadorias, Devoluções e Lista de Clientes estão dentro do comentário e, portanto, são ignorados.

Comentários em linha

Inline Comments são um subtipo dos comentários Multi-Line regulares. Com um início e fim bem definidos, eles também podem ser inseridos entre as instruções. É importante garantir que o fluxo de leitura não seja muito comprometido. No entanto, se você deseja explicar um determinado trecho de uma linha, os comentários em linha podem ser uma boa escolha. No exemplo simples a seguir, você verá como funciona um comentário desse tipo:

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

O sistema exibirá sem restrições toda a tabela chamada “Funcionários” e todas suas colunas e campos. O comentário é visível apenas para você ou para outro usuário do código.