Comentários do SQL Server

As declarações SQL são significativas para interagir e trabalhar com seus bancos de dados. Essas declarações podem ser uma única linha de código ou consultas de várias linhas. Se você tiver muitas declarações SQL, pode se tornar difícil conhecer o objetivo pretendido do código.

Uma ótima maneira de ajudar a manter e melhorar a legibilidade em suas declarações SQL é o uso de comentários. Por exemplo, você pode adicionar comentários ao documento ou descrever a lucidez do script. Como o SQL Server não executa comentários SQL, também podemos usá -los para desativar um bloco de código específico, permitindo que você depure e refator.

Este tutorial aprenderá a usar e adicionar comentários às suas consultas SQL. Discutiremos como usar comentários de linha única e várias linhas no SQL Server.

O básico

Existem duas maneiras principais de usar para criar comentários em suas consultas SQL. O primeiro usa um traço duplo e o outro usa uma barra para frente e um asterisco.

Vamos aprender a criar comentários usando as sintaxes descritas acima.

Comentários de linha única

Para criar um comentário de linha única nas consultas do SQL Server, use o símbolo -. A sintaxe é como mostrado:

-- comentário_text

Quando o SQL Server encontra uma linha que começa com o símbolo, ele ignorará todo o conteúdo até o final da linha. O novo personagem da linha atua como o valor final para um comentário que começa com - símbolos.

Considere o exemplo mostrado abaixo:

-- Obtenha 5 valores da tabela de clientes
Selecione Top 5 * dos clientes;

No exemplo da consulta SQL acima, usamos um comentário de linha única para adicionar uma descrição da ação executada pela instrução SQL que se segue.

É bom observar que não há limite máximo para o número de caracteres que um comentário contém.

Usando o Microsoft SQL Server Management Studio, você pode adicionar um comentário de linha única usando o atalho do teclado Ctrl + K, Ctrl + C.

Você também pode usar a interface gráfica clicando no ícone mostrado abaixo na barra de ferramentas principal.

Depois de selecionar e usar os atalhos do teclado ou o ícone de comentário, o servidor SQL adicionará dois hífens e comentará a linha definida.

Comentários de várias linhas

O outro tipo de comentário é de comentários de várias linhas ou blocos. Estes são o tipo de comentário que abrange mais de uma única linha, como um parágrafo.

Digamos que você queira comentar as seguintes linhas:

-- Obtenha o primeiro nome do cliente
-- Obtenha sobrenome do cliente
Selecione 5 Top 5 FirstName, SoldName dos clientes;

Você percebe que temos que adicionar dois comentários de linha única. Este método torna o código ilegível e repetitivo.

Podemos consertar isso inserindo um comentário de várias linhas usando a sintaxe mostrada abaixo:

/* Comente aqui
outra linha
e outro
*/

O SQL Server usa A / * para abrir um comentário de várias linhas e * / para fechar o bloco de comentários. O SQL Server ignorará qualquer texto especificado nesses blocos.

Considere o código de exemplo mostrado abaixo:

Comentários de várias linhas são muito úteis quando você tem comentários que estendem várias linhas. Você também pode usá -los para exibir informações úteis, como autor, data e muito mais.

/*
Autor: Linuxhint;
Categoria: SQL Server;
Pub: 2022;
*/
Selecione 5 Top 5 FirstName, SoldName dos clientes;

Da mesma forma, os comentários do bloco podem desativar várias consultas SQL.

Conclusão

Este guia ensina como trabalhar com os comentários do SQL Server para adicionar informações aos seus scripts SQL. Comentar sobre o código ajuda a melhorar a legibilidade e manutenção do código por outros desenvolvedores. Obtenha o hábito de comentar seu código.

Obrigado pela leitura.