Resumo: neste tutorial, você aprenderá como usar o comentário do MySQL para documentar uma instrução SQL ou um bloco de código no MySQL.
Os comentários podem ser usados para documentar o propósito de uma instrução SQL ou a lógica de um bloco de código em um procedimento armazenado. Ao analisar o código SQL, o MySQL ignora a parte dos comentários. Ele apenas executa a parte SQL, exceto para o comentário executável, que discutiremos na próxima seção.
O MySQL suporta três estilos de comentário:
- De um
"-- "
até o final da linha. O estilo de comentário de traço duplo requer pelo menos espaço em branco ou caractere de controle (espaço, tabulação, nova linha, etc) após o segundo traço.SELECT * FROM users; -- This is a comment
Observe que o SQL padrão não exige um espaço em branco após o segundo travessão. O MySQL usa um espaço em branco para evitar problemas com alguma construção SQL, como:
SELECT 10--1;
A instrução retorna 11. Se o MySQL não usasse o espaço em branco, em vez disso, retorne 10.
- De um
"#"
até o final da linha.SELECT lastName, firstNameFROM employeesWHERE reportsTo = 1002; # get subordinates of Diane
- O comentário estilo C
/**/
pode abranger várias linhas. Use este estilo de comentário para documentar um bloco de código SQL./* Get sales rep employees that reports to Anthony*/SELECT lastName, firstNameFROM employeesWHERE reportsTo = 1143 AND jobTitle = "Sales Rep";
Observe que o MySQL não suporta comentários aninhados.
Comentários executáveis
O MySQL fornece comentários executáveis para oferecer suporte à portabilidade entre bancos de dados diferentes. Esses comentários permitem que você incorpore código SQL que será executado apenas no MySQL, mas não em outros bancos de dados.
O seguinte ilustra a sintaxe do comentário executável:
Code language: SQL (Structured Query Language) (sql)
Por exemplo, a seguinte instrução usa um comentário executável:
Code language: SQL (Structured Query Language) (sql)
A instrução retorna 2 em vez de 1. No entanto, retornará 1 se você executar em outros sistemas de banco de dados.
Se você quiser executar um comentário de uma versão específica do MySQL, use a seguinte sintaxe:
Code language: SQL (Structured Query Language) (sql)