Comentários sobre MySQL

Resumo : neste tutorial, você aprenderá como usar comentários do MySQL para documentar seu código no MySQL.

Os comentários do MySQL são essenciais para documentar o esquema do seu banco de dados, consultas SQL e procedimentos armazenados .

Eles ajudam você e outros desenvolvedores a entender o código e sua finalidade.

1) Comentários de linha única

Comentários de linha única são usados ​​para adicionar comentários em uma única linha.

MySQL suporta dois tipos de comentários de linha única:

Usando--

Você pode adicionar um comentário de linha única usando dois hífens ( --) seguidos do texto do seu comentário. Qualquer texto seguindo --a mesma linha é tratado como um comentário. Por exemplo:

-- This is a single-line comment
SELECT * FROM employees;

Usando#

Alternativamente, você pode usar o #símbolo de hash ( ) para adicionar comentários de linha única. Qualquer texto seguindo #a mesma linha é tratado como um comentário. Por exemplo:

# This is another single-line comment
SELECT * FROM customers;Linguagem de código:  PHP  ( php )

2) Comentários multilinhas

Comentários de várias linhas permitem adicionar comentários abrangendo várias linhas. MySQL suporta dois tipos de comentários multilinhas:

Delimitado por/* ... */

Você pode incluir seus comentários /*e */criar comentários de várias linhas. Tudo entre a abertura /*e o fechamento */é tratado como comentário. Por exemplo:

/* This is a
   multi-line comment */
SELECT * FROM orders;Linguagem de código:  JavaScript  ( javascript )

Usando --para comentários multilinhas

Embora --seja principalmente para comentários de linha única, você pode usá-lo para comentários de várias linhas adicionando --no início de cada linha. Por exemplo:

-- This is a multi-line comment
-- that spans multiple lines
SELECT * FROM products;

3) Comentários executáveis

No MySQL, comentários executáveis ​​suportam portabilidade entre diferentes bancos de dados. Esses comentários permitem incorporar 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:

/*! MySQL-specific code */Linguagem de código:  SQL (linguagem de consulta estruturada)  ( sql )

Por exemplo, a instrução a seguir usa um comentário executável:

SELECT 1 /*! +1 */Linguagem de código:  SQL (linguagem de consulta estruturada)  ( sql )

A instrução retorna 2 em vez de 1. No entanto, retornará 1 se você executá-la em outros sistemas de banco de dados.

Se você deseja executar um comentário de uma versão específica do MySQL, use a seguinte sintaxe:

/*!##### MySQL-specific code */Linguagem de código:  SQL (linguagem de consulta estruturada)  ( sql )

A string ‘#####’ representa a versão mínima do MySQL que pode executar o comentário. O primeiro # é a versão principal, por exemplo, 5 ou 8. Os segundos 2 números (##) são a versão secundária. E os 2 últimos são o nível do patch.

Por exemplo, o seguinte comentário só é executável no MySQL 5.1.10 ou posterior:

CREATE TABLE t1 (
    k INT AUTO_INCREMENT,
    KEY (k)
)  /*!50110 KEY_BLOCK_SIZE=1024; */Linguagem de código:  SQL (linguagem de consulta estruturada)  ( sql )

Resumo

• Use comentários para documentar suas instruções SQL, esquemas e procedimentos armazenados.