Как вы блокируете комментарии в YAML?

Question

Как мне закомментировать блок строк в YAML?

Answer 1

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

Answer 2

spec описывает только один способ пометки комментариев:

Явный комментарий отмечен знаком «#».

Вот и все. Блочных комментариев нет.

Answer 3

Не пытайтесь проявить смекалку, но если вы используете Sublime Text для своего редактора, выполните следующие шаги:

1. Выберите блок
2. cmd + / на Mac или ctrl + / в Linux и Windows
3. Прибыль

Я полагаю, что другие редакторы также имеют аналогичную функциональность. Какой вы используете? Я был бы рад покопаться.

Answer 4

В Vim вы можете выполнить одно из следующих действий:

• Комментировать все строки: :%s/^/#
• Строки комментариев 10 - 15: :10,15s/^/#
• Строка комментария 10 к текущей строке: :10,.s/^/#
• Строка комментария 10 до конца: :10,$s/^/#

или с использованием визуального блока:

1. Выберитемногострочный столбец после ввода визуального блока с помощью Ctrl + v .
2. Нажмите r , затем # , чтобы закомментировать многострочный блокзаменяя выделение, или Shift + i # Esc для вставки символов комментария перед выделением.

Answer 5

Альтернативный подход:

Если

• ваша структура YAML имеет четко определенные поля, которые будут использоваться вашим приложением
• И вы можете свободно добавлять дополнительные поля, которые не будут мешать вашему приложению

тогда

• на любом уровне вы можете добавить новое текстовое поле блока, названное как «Описание» или «Комментарий» или «Заметки» или что-то еще

Пример:

вместо

# This comment
# is too long

использование

Description: >
  This comment
  is too long

или

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

Больше преимуществ:

1. Если комментарии становятся большими и сложными и имеют повторяющийся узор, вы можете превратить их из простых текстовых блоков в объекты
2. Ваше приложение может - в будущем - прочитать или обновить эти комментарии

Answer 6

Если вы используете Eclipse с плагином yedit (редактор для файлов .yaml), вы можете закомментировать несколько строк следующим образом:

1. выбор строк для комментария, а затем
2. Ctrl + Shift + C

И чтобы оставить комментарий, выполните те же шаги.

Answer 7

В Emacs есть comment-dwim (Do What I Mean) - просто выберите блок и выполните:

M -;

Это переключатель - используйте его для комментирования и раскомментирования блоков.

Если у вас не установлен режим yaml, вам нужно указать Emacs использовать символ хеша (#).

Answer 8

Для пользователей Ruby Mine в Windows:

Открыть файл в редакторе Выберите блок и нажмите Ctrl + косая черта , вы выберете блок, начинающийся с #.

Теперь, если вы хотите откомментировать комментируемый блок, нажмите ту же комбинацию клавиш Ctrl + косая черта снова

Answer 9

Для пользователей кода Visual Studio (VSCode), чтобы закомментировать несколько строк, выделите строки, которые вы хотите прокомментировать, и нажмите:

ctrl + /

Повторное нажатие ctrl + / также можно использовать для отключения комментариев для одной или нескольких выбранных строк.

Answer 10

Единственный способ заблокировать комментарий в YAML - использовать другое приложение для добавления тега # (comment) к нескольким строкам одновременно.Примером этого является опция «Блокировать комментарий» для выбранного текста в Блокноте ++.