Jak blokujesz komentarze w YAML?

Jak skomentować blok wierszy w YAML?

YAML obsługuje komentarze wbudowane, ale nie obsługuje komentarzy blokowych.

Z Wikipedii :

Komentarze zaczynają się od znaku liczbowego ( #), mogą zaczynać się w dowolnym miejscu wiersza i kontynuować do końca wiersza

Porównanie z JSON, również z Wikipedii :

Różnice w składni są subtelne i rzadko pojawiają się w praktyce: JSON dopuszcza rozszerzone zestawy znaków, takie jak UTF-32, YAML wymaga spacji po separatorach, takich jak przecinek, znak równości i dwukropek, podczas gdy JSON nie, a niektóre niestandardowe implementacje JSON rozszerzają gramatykę na dołącz /* ... */komentarze Javascript . Obsługa takich przypadków na krawędziach może wymagać wstępnego przetworzenia JSON przed parsowaniem jako wbudowanego YAML.

# If you want to write
# a block-commented Haiku
# you'll need three pound signs

Specyfikacja opisuje tylko jeden sposób znakowania komentarzy:

Wyraźny komentarz jest oznaczony wskaźnikiem „#”.

To wszystko. Brak komentarzy blokowych.

Nie próbujesz być mądry, ale jeśli używasz Sublime Text w swoim edytorze, kroki są następujące:

1. Wybierz blok
2. cmd+ /na Mac lub ctrl+ /na Linux i Windows
3. Zysk

Wyobrażam sobie, że inne edytory również mają podobną funkcjonalność. Z którego korzystasz? Byłbym szczęśliwy, mogąc trochę kopać.

W Vimie możesz wykonać jedną z następujących czynności:

• Skomentuj wszystkie linie: :%s/^/#
• Linie komentarza 10–15: :10,15s/^/#
• Linia komentarza 10 do bieżącej linii: :10,.s/^/#
• Linia komentarza 10 do końca: :10,$s/^/#

lub używając bloku wizualnego:

1. Wybierz kolumnę z wieloma wierszami po wprowadzeniu bloku wizualnego za pomocą Ctrl+v.
2. Naciśnij, ra następnie, #aby skomentować blok wielowierszowy zastępujący wybór lub Shift+i#Escwstawić znaki komentarza przed wyborem.

Alternatywne podejście:

Gdyby

• Twoja struktura YAML ma dobrze zdefiniowane pola do użycia przez Twoją aplikację
• ORAZ możesz swobodnie dodawać dodatkowe pola, które nie zepsują Twojej aplikacji

następnie

• na dowolnym poziomie możesz dodać nowe pole tekstowe bloku o nazwie „Opis” lub „Komentarz” lub „Notatki” lub cokolwiek innego

Przykład:

Zamiast

# This comment
# is too long

posługiwać się

Description: >
  This comment
  is too long

lub

Comment: >
    This comment is also too long
    and newlines survive from parsing!

Więcej zalet:

1. Jeśli komentarze stają się duże i złożone i mają powtarzający się wzorzec, możesz promować je z bloków zwykłego tekstu do obiektów
2. Twoja aplikacja może - w przyszłości - czytać lub aktualizować te komentarze

Jednym ze sposobów blokowania komentowania w YAML jest użycie edytora tekstu, takiego jak Notepad ++, aby dodać znacznik # (komentarz) do wielu wierszy jednocześnie.

W Notepad ++ możesz to zrobić za pomocą opcji „Blokuj komentarz” prawym przyciskiem myszy dla zaznaczonego tekstu.

Jeśli używasz Eclipse z wtyczką yedit (edytor plików .yaml), możesz skomentować wiele wierszy poprzez:

1. wybieranie linii do skomentowania, a następnie
2. Ctrl+ Shift+C

Aby anulować komentarz, wykonaj te same kroki.

Dla użytkowników Ruby Mine w systemie Windows:

Otwórz plik w edytorze Wybierz blok i naciśnij Ctrl+ forward slash, wybierzesz blok zaczynający się od #.

Teraz, jeśli chcesz, aby cofnąć komentarzu komentowanym blok, połączenie naciśnij ten sam przycisk Ctrl+ forward slashponownie

Emacs ma komentarz-dwim (Rób co mam na myśli) - po prostu zaznacz blok i wykonaj:

M-;

Jest to przełącznik - użyj go do komentowania ORAZ odkomentowania bloków.

Jeśli nie masz zainstalowanego trybu yaml, musisz powiedzieć Emacsowi, aby użył znaku krzyżyka (#).

Dla użytkowników Visual Studio Code (VSCode) skrót do komentowania wielu linii polega na zaznaczeniu linii, które chcesz skomentować, a następnie naciśnij:

ctrl + /

Ponowne naciśnięcie ctrl+ /może również służyć do wyłączania komentarzy dla jednego lub więcej wybranych wierszy.

W przeglądarce Azure Devops (edytor yaml potoku)

Ctrl+ K+ CBlok komentarzy

Ctrl+ K+ UUncomment Block

Istnieje również opcja „Przełącz blokowanie komentarza”, ale to nie działało dla mnie.

Są też inne „dziwne” sposoby: kliknij prawym przyciskiem myszy, aby wyświetlić „Paletę poleceń” lub F1

Następnie wybierz opcję kursora.

Teraz to tylko kwestia #

a nawet mądrzejszy [ Ctrl+ k] + [ Ctrl+ c]