YAML - Commenti

Ora che sei a tuo agio con la sintassi e le basi di YAML, procediamo ulteriormente nei suoi dettagli. In questo capitolo vedremo come utilizzare i commenti in YAML.

YAML supports single line comments. La sua struttura è spiegata di seguito con l'aiuto di un esempio:

# this is single line comment.

YAML does not support multi line comments. Se desideri fornire commenti per più righe, puoi farlo come mostrato nell'esempio seguente:

# this
# is a multiple
# line comment

Caratteristiche dei commenti

Le caratteristiche dei commenti in YAML sono riportate di seguito:

  • Un blocco commentato viene saltato durante l'esecuzione.

  • I commenti aiutano ad aggiungere una descrizione per il blocco di codice specificato.

  • I commenti non devono apparire all'interno degli scalari.

  • YAML non include alcun modo per sfuggire al simbolo cancelletto (#) quindi all'interno di una stringa multilinea quindi non c'è modo di dividere il commento dal valore della stringa non elaborata.

I commenti all'interno di una raccolta sono mostrati di seguito:

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

La combinazione di tasti di scelta rapida per commentare i blocchi YAML è Ctrl+Q.

Se stai usando Sublime Text editor, i passaggi per commentare il blocco sono indicati di seguito:

Seleziona il blocco. Utilizzare "CTRL + /" su Linux e Windows e "CMD + /" per il sistema operativo Mac. Esegui il blocco.

Notare che gli stessi passaggi sono applicabili se si utilizza Visual Studio Code Editor. Si consiglia sempre di utilizzareSublime Text Editor per la creazione di file YAML in quanto supportato dalla maggior parte dei sistemi operativi e include tasti di scelta rapida per sviluppatori.