Как я добавляю комментарии в markdown?

2024-09-02

Краткая версия

Markdown не поддерживает комментарии на нативном уровне. Используйте вместо этого HTML-комментарии.

<!-- Это комментарий -->

Длинная версия

Введение

Хотя Markdown идеально подходит для создания отформатированного текста, у него нет встроенной функции комментариев. Однако вы все равно можете добавлять комментарии, используя элементы HTML-комментариев.

Добавление комментариев в Markdown

Чтобы добавить комментарии в ваш Markdown-файл, просто используйте синтаксис HTML-комментариев. Все, что написано между , будет игнорироваться во время отображения:

<!-- Этот комментарий не появится в выводе -->

Вы можете добавлять комментарии в любом месте вашего документа, не затрагивая содержимое вывода.

Заключение

Для добавления комментариев в Markdown использование HTML-комментариев остается лучшим подходом. Таким образом, вы можете включать заметки и объяснения в ваш исходный Markdown, которые не появятся в финальном документе.