Comentários são usados para adicionar informações ao código. Geralmente é ignorado pelo compilador, mas especialistas humanos podem ler esses comentários quando visualizam seu código. Os comentários são essenciais para os desenvolvedores porque eles têm tempo limitado, e comentar permite que eles obtenham informações valiosas de uma só vez ou observem alguns detalhes cruciais em relação ao código. O acesso a esses dados permite que eles tomem as decisões certas e trabalhem mais rápido.
Como os comentários podem ser úteis para mim?
Os comentários são úteis para você pessoalmente e para qualquer pessoa que precise ler ou editar este código posteriormente. Mas como exatamente?
- Os comentários podem ser espaços reservados durante a codificação. Nesse momento, você pode supor algo e saber se sua suposição é verdadeira no futuro.
- Os comentários podem documentar seus pensamentos ou ser anotações para você mesmo, para que você não esqueça o que fez quando voltar a eles mais tarde.
- Você pode incluir comentários sobre o que você fez em seu código para que outros programadores o entendam melhor e mais rápido (o tempo dos codificadores é muito, muito caro).
- Você pode usar comentários para desativar ou ativar temporariamente partes com bugs.
- Comentar em cada linha de um script torna mais simples rastrear onde os bugs podem estar dentro do programa.
- Os comentários podem explicar o que certas linhas de código estão fazendo ou por que você escolheu uma abordagem específica para evitar mal-entendidos (por exemplo, quando algumas partes do código são destinadas a alguma seção ou a um propósito específico que você deve entender claramente) ,
- Você pode escrever um parágrafo inteiro explicando todos os detalhes sobre a seção de código, se necessário para novatos ou pessoas de outros projetos. Muitas vezes, é necessário comentar ao escrever consultas SQL complexas com muitas cláusulas, como INNER JOINs, GROUP BYs etc.
- Os comentários permitem que você faça anotações sobre o que está fazendo. Isso ajuda outras pessoas a entender como e por que você fez algo para que possam mantê-lo ou modificá-lo conforme necessário.
O SQL é uma boa linguagem para comentários?
Sim! Os comentários são mais frequentemente usados em conjunto com linguagens como SQL e PHP, onde podemos inseri-los em um arquivo de texto ou script usando a função de comentário * / (por exemplo, /* Este é meu comentário */). Normalmente, eles também são fáceis de usar em qualquer outro lugar.
Como comentar em SQL?
A função de comentário permitirá que você escreva qualquer texto para adicionar um comentário em SQL. Não afeta a saída final desde que venha antes ou depois de um caractere pré-programado definido.
Para adicionar comentários em SQL, você pode usar os seguintes símbolos:/* */ ou # ou — (traço duplo).
/* */ funcionará para qualquer situação em que você deseja iniciar e terminar seu comentário nesse ponto sem usar mais nada (como aspas simples).
# é usado para uma linha de código de cada vez
— também se aplica a uma linha de código por vez. Não se esqueça de colocar um espaço após este traço duplo.
No seu código ficaria assim:
-- this is a comment# this is also a comment/*
multiline
comment
*/
Aqui está a diferença entre os comentários de uma linha e de várias linhas:
mysql> SELECT 1+1; # This comment continues to the end of line
mysql> SELECT 1+1; -- This comment continues to the end of line
mysql> SELECT 1 /* this is an in-line comment */ + 1;
mysql> SELECT 1+
/*
this is a
multiple-line comment
*/
1;
Aqui está outro exemplo de um comentário de várias linhas:
SELECT contact_id, last_name, first_name
/*
* Author: TechOnTheNet.com
* Purpose: To show a comment that spans multiple lines in your SQL
* statement in MySQL.
*/
FROM contacts;
Comentando usando o símbolo #
O básico comentários de hash style pode ser inserido no texto como este:
Select * from users ; # this will list usersComentando usando o traço duplo (–)
Isso é mais ou menos o mesmo (não se esqueça do espaço). O SQL padrão não exige que você use o espaço lá, mas o MySQL o usa para evitar problemas com comandos como SELECT 10–1.
Select * from users ; -- this will list usersComentando usando os símbolos / * e * /
Este comentário de várias linhas, ao contrário dos dois exemplos anteriores, não precisa parar no final da linha.
Select * from users ; /* this will list users */Comentários executáveis
Via de regra, os comentários são ignorados por quem está do outro lado (porque são apenas para programadores), mas alguns tipos de comentários – comentários executáveis – habilitam o código rodando em alguns sistemas.
No nosso caso, comentários executáveis permitem que você use códigos SQL que serão executados apenas em MYSQL, não em outros bancos de dados.
Os comentários executáveis devem estar contidos em barras com asterisco , como com o código usual:
/*! Código específico do MySQL */
No entanto, esses comentários executáveis exigem uma sintaxe específica, como abaixo:
/*!##### código específico do MySQL */
Você precisa do !##### parte para sinalizar comentários executáveis. Ele representa a versão mínima do MYSQL que pode executar comentários.
Em vez do primeiro hash, substitua a versão principal do MYSQL. Em vez da segunda, a versão mais nova e as versões do patch são substituídas pelas 2 últimas.
Somente o MySQL 5.1.10 ou versão posterior pode executar os seguintes comentários:
CREATE TABLE t1 (
k INT AUTO_INCREMENT,
KEY (k)
) /*!50110 KEY_BLOCK_SIZE=1024; */
Conclusão
Os comentários facilitam a leitura dos programas adicionando mais detalhes. Você pode pensar neles como algo semelhante a hashes – eles reduzem o tempo necessário para entender o código ou identificar algumas partes dele drasticamente, fornecendo trechos que capturam a essência do texto. Se você já trabalhou com provas de conhecimento zero ou tentou fazer login no Facebook pelo Google, sabe o que queremos dizer.
Por isso é essencial comentar seu código e saber como fazê-lo corretamente. Manter seu código preciso com notas informativas facilita a vida de todos os especialistas envolvidos.
