YAML - komentarze

Teraz, gdy znasz już składnię i podstawy YAML, przejdźmy dalej do jego szczegółów. W tym rozdziale zobaczymy, jak używać komentarzy w YAML.

YAML supports single line comments. Jego strukturę wyjaśniono poniżej na przykładzie -

# this is single line comment.

YAML does not support multi line comments. Jeśli chcesz podać komentarze do wielu wierszy, możesz to zrobić, jak pokazano w poniższym przykładzie -

# this
# is a multiple
# line comment

Funkcje komentarzy

Funkcje komentarzy w YAML podano poniżej -

Komentowany blok jest pomijany podczas wykonywania.
Komentarze pomagają dodać opis do określonego bloku kodu.
Komentarze nie mogą pojawiać się wewnątrz skalarów.
YAML nie zawiera żadnego sposobu na uniknięcie symbolu krzyżyka (#), więc w ciągu wieloliniowym nie ma możliwości podzielenia komentarza od nieprzetworzonej wartości ciągu.

Komentarze w ramach kolekcji są pokazane poniżej -

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

Kombinacja klawiszy skrótu do komentowania bloków YAML to Ctrl+Q.

Jeśli używasz Sublime Text editor, kroki komentowania bloku są wymienione poniżej -

Wybierz blok. Użyj „CTRL + /” w systemie Linux i Windows oraz „CMD + /” w systemie operacyjnym Mac. Wykonaj blok.

Pamiętaj, że te same kroki mają zastosowanie, jeśli używasz Visual Studio Code Editor. Zawsze zaleca się użycieSublime Text Editor do tworzenia plików YAML, ponieważ jest obsługiwany przez większość systemów operacyjnych i zawiera przyjazne dla programistów klawisze skrótów.