Как закомментировать блок строк в YAML?
YAML поддерживает встроенные комментарии, но не поддерживает блочные комментарии.
Из Википедии:
Комментарии начинаются со знака числа (
#
), могут начинаться в любом месте строки и продолжаться до конца строки.
Сравнение с JSON, также из Википедии:
Различия в синтаксисе очень тонкие и редко возникают на практике: JSON позволяет использовать расширенные наборы символов, такие как UTF-32, YAML требует пробел после разделителей, таких как запятая, равенство и двоеточие, в то время как JSON этого не делает, и некоторые нестандартные реализации JSON расширяют грамматику, чтобы включить Javascript'ы
/* .... */
комментарии. Для обработки таких крайних случаев может потребоваться легкая предварительная обработка JSON перед разбором как встроенного YAML.
# If you want to write
# a block-commented Haiku
# you'll need three pound signs
В spec описан только один способ маркировки комментариев:
Явный комментарий помечается индикатором "#".
Это все. Блочных комментариев не существует.
Не пытаюсь умничать, но если вы используете Sublime Text в качестве редактора, то шаги следующие:
Я полагаю, что и другие редакторы имеют подобную функциональность. Какой из них вы используете? Я буду рад немного покопаться.
В Vim, вы можете сделать одно из следующих действий:
:%ы/^/#
:10,15 с/^/#
:10,.с/^/#
:10, С$s/^/#
или используя визуальный блок:
Альтернативный подход:
Если
тогда
Пример:
Вместо
# This comment
# is too long
использовать
Description: >
This comment
is too long
или
Comment: >
This comment is also too long
and newlines survive from parsing!
Дополнительные преимущества:
Если вы используете Eclipse с плагином yedit (редактор для .файлы YAML), вы можете закомментировать несколько строк:
И в ООН-комментарий, выполните те же шаги.
Emacs есть комментарий-dwim (делать то, что я имею в виду) - просто выберите блок и сделать:
м-;
Это'ов переключатель - использовать его, чтобы закомментировать и раскомментировать блоки.
Если вы Don'т иметь в YAML-режиме установлена, вы должны будете сказать Emacs, чтобы использовать хэш-символ (#).
Для пользователей Рубиновая шахта в Windows:
Открыть файл в Редакторе Выберите блок и нажмите <и>сочетание клавиш Ctrl</роз>+<и>Слэш</роз>, вы будете иметь выбранного блока начиная с #.
Теперь, если вы хотите, чтобы раскомментировать закомментированный блок, нажмите же комбинацию клавиш <и>сочетание клавиш Ctrl</роз>+<и>Слэш</роз> снова
Для Visual Studio кода (VSCode пользователей), ярлык, чтобы закомментировать несколько строк, чтобы выделить строки, которые вы хотите прокомментировать и нажмите клавишу:
<и>сочетание клавиш Ctrl</роз> + <и>/</КБД>
Нажав <и>сочетание клавиш Ctrl</роз> + <и>/</роз> опять же может быть использован для переключения комментарии к записи для одного или нескольких выбранных линий.
Один из способов блокировать комментирование в YAML это в текстовом редакторе, таком как Notepad++, чтобы добавить # (комментарий) тега на несколько строк сразу.
В Notepad++ вы можете сделать это, используя в "Комментарии" и нажав правой кнопкой мыши на выделенный текст.