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

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

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

или используя визуальный блок:

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

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

If

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

тогда

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

Пример:

Вместо того

# This comment
# is too long

использовать

Description: >
  This comment
  is too long

or

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

Дополнительные преимущества:

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

Один из способов заблокировать комментирование в YAML - использовать текстовый редактор, например Notepad ++, чтобы добавить тег # (комментарий) сразу к нескольким строкам.

В Notepad ++ это можно сделать, щелкнув правой кнопкой мыши параметр «Заблокировать комментарий» для выделенного текста.

В Emacs есть comment-dwim (Делайте то, что я имею в виду) - просто выберите блок и выполните:

M-;

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

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

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

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

Чтобы отменить комментарий, выполните те же действия.

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

ctrl + /

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

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

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

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

В браузере Azure Devops (редактор yaml конвейера)

Ctrl + K + C Блок комментариев

Ctrl + K + U Раскомментировать блок

Также есть опция «Переключить блокировку комментариев», но у меня она не сработала.

Есть и другие "странные" способы: щелкните правой кнопкой мыши, чтобы увидеть "Командную палитру" или F1

Затем выберите вариант курсора.

Теперь осталось всего лишь #

или даже умнее [Ctrl + k] + [Ctrl + c]

В файле .gitlab-ci.yml следующие работы:

Чтобы закомментировать блок (многострочный): выделите всю секцию блока ›Ctrl K C

Чтобы раскомментировать уже закомментированный блок (многострочный): выделите весь раздел блока ›Ctrl K U