YAML - Comentários

Agora que você está confortável com a sintaxe e os fundamentos do YAML, vamos prosseguir com seus detalhes. Neste capítulo, veremos como usar comentários em YAML.

YAML supports single line comments. Sua estrutura é explicada a seguir com a ajuda de um exemplo -

# this is single line comment.

YAML does not support multi line comments. Se você quiser fornecer comentários para várias linhas, pode fazê-lo conforme mostrado no exemplo abaixo -

# this
# is a multiple
# line comment

Características dos comentários

Os recursos dos comentários em YAML são fornecidos abaixo -

Um bloco comentado é ignorado durante a execução.
Os comentários ajudam a adicionar uma descrição para o bloco de código especificado.
Os comentários não devem aparecer dentro dos escalares.
YAML não inclui nenhuma maneira de escapar do símbolo hash (#), portanto, dentro da string de várias linhas, portanto, não há como dividir o comentário do valor da string bruta.

Os comentários dentro de uma coleção são mostrados abaixo -

key: #comment 1
   - value line 1
   #comment 2
   - value line 2
   #comment 3
   - value line 3

A combinação de teclas de atalho para comentar blocos YAML é Ctrl+Q.

Se você estiver usando Sublime Text editor, as etapas para comentar o bloco são mencionadas abaixo -

Selecione o bloco. Use “CTRL + /” no Linux e Windows e “CMD + /” no sistema operacional Mac. Execute o bloqueio.

Observe que as mesmas etapas são aplicáveis se você estiver usando Visual Studio Code Editor. É sempre recomendável usarSublime Text Editor para criar arquivos YAML, pois é compatível com a maioria dos sistemas operacionais e inclui teclas de atalho para desenvolvedores.