Você também encontrará os comentários em vários contextos de banco de dados, como procedimentos armazenados, funções, gatilhos e visualizações. Eles podem fornecer as explicações de código, alterações ou modificações de documentos ou deixar notas para os outros desenvolvedores que trabalham na mesma base de código.
Neste tutorial, você aprenderá a usar e trabalhar com os vários tipos de comentários na linguagem PL/SQL.
Comentários de linha única
O primeiro tipo de comentário nos bancos de dados Oracle são comentários de linha única. Comentários de linha única são comentários que abrangem uma única linha.
Em PL/SQL, um comentário de linha única começa com dois hífens (-) e se estende até o final da linha. O mecanismo de banco de dados ignora qualquer texto ou caracteres que venham após os hífens quando o código é executado.
A seguir, mostra o exemplo de um comentário de linha única no Oracle:
COMEÇAR
-- Este é um comentário de linha única
DECLARAR
Nome Varchar2 (30);
COMEÇAR
Nome: = 'Peter';
FIM;
FIM;
Nesse caso, o texto após o comentário é tratado como um comentário e ignorado durante a execução do comando.
Além de adicionar a meta informação a um determinado bloco de código, comentários de linha única ajudam a desativar um pedaço de código.
Um exemplo é o seguinte:
-- Inserir em produtos (product_name, quantidade, preço) valores ('Microsoft Volterra', 0, 599);
Embora a declaração anterior seja um comando PL/SQL válido, o mecanismo de banco de dados não o executa como é tratado como um comentário.
Comentário multineiro do Oracle
O segundo tipo de comentários nos bancos de dados Oracle são comentários de várias linhas. Estes são o tipo de comentário que pode abranger várias linhas.
Um comentário de várias linhas no Oracle começa com uma barra para frente e um asterisco (/*). O comentário pode então abranger o maior número possível de linhas. Para encerrar um comentário de várias linhas, comece com um asterisco e uma barra para a frente (*/).
Exemplo:
COMEÇAR
/*
Este é um comentário de várias linhas.
Ele pode abranger várias linhas e pode ser usado para fornecer explicações ou documentação mais detalhadas.
*/
DECLARAR
Nome Varchar2 (30);
COMEÇAR
Nome: = Peter ';
FIM;
FIM;
Também podemos usar um comentário de várias linhas como um comentário de linha única:
Selecione * dos funcionários; / * Este é um comentário de várias linhas que abrange uma única linha */
Lá, você aprendeu a trabalhar com comentários de linha única e de várias linhas em PL/SQL.
É bom observar que o Oracle não suporta os comentários de várias linhas aninhadas. Por exemplo, o código a seguir é inválido:
COMEÇAR
/* Este é um comentário de várias linhas
/ * Este é um comentário de várias linhas aninhadas */
*/
DECLARAR
Nome Varchar2 (30);
COMEÇAR
Nome: = 'Peter';
FIM;
FIM;
A consulta anterior falha, já que os comentários de várias linhas aninhados não são suportados.
Se você deseja adicionar um comentário aninhado, pode combinar os comentários de várias linhas e de linha única, como mostrado no seguinte:
COMEÇAR
/* Este é um comentário de várias linhas
-- Este é um comentário de linha única no comentário de várias linhas
*/
DECLARAR
Nome Varchar2 (30);
COMEÇAR
Nome: = 'Peter';
FIM;
FIM;
Conclusão
Neste tutorial, você aprendeu a usar os vários tipos de comentários em PL/SQL para adicionar uma documentação ao seu código.