Markdown: Комментарий

Markdown - один из самых популярных языков разметки в мире. Созданный Джоном Грубером в 2004 году, Markdown - это простой и легкий язык разметки, который позволяет добавлять элементы форматирования в обычный текст.

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

Как работает Markdown?

Как уже упоминалось, Markdown - это язык разметки. Поэтому вы работаете в файле, заканчивающемся расширением .md или .markdown. Этот файл содержит элементы форматирования, такие как заголовки, блоки кода, отступы, выравнивания и т. д.

Документ в формате markdown обрабатывается приложением, известным как Markdown processor или parser. Затем парсер принимает отформатированный текст и создает документ HTML. Затем HTML-документ можно просмотреть в браузере или любом другом приложении, которое его поддерживает.

Что такое комментарий в формате Markdown?

Комментарий Markdown - это текст, добавленный в файл Markdown, но игнорируемый приложением рендеринга. Таким образом, комментарий в формате Markdown не отображается в сгенерированном выводе.

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

Как вставлять комментарии в формате Markdown

К сожалению, Markdown не обеспечивает встроенную поддержку комментариев. Однако вы можете использовать импортированные решения для добавления комментариев в документ Markdown.

Способ 1

Первый синтаксис для добавления комментария в Markdown - это размещение текста комментария внутри пары квадратных скобок, за которыми следуют двоеточие, пробел и знак фунта.

Синтаксис выглядит следующим образом:

Текст внутри квадратных скобок рассматривается как комментарий и игнорируется рендерером Markdown.

Пример показан на рисунке:

В приведенном выше примере мы имеем простой синтаксис Markdown с заголовком, абзацем, комментарием и еще одним абзацем.

Метод 2

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

Это считается наиболее совместимым с платформами форматом для добавления комментариев.

Другая вариация этого синтаксиса выглядит следующим образом:

Метод 3

В некоторых движках Markdown можно пропустить две прямые косые черты и использовать следующий синтаксис:

или

или

Метод 4

Вы также можете включать HTML-комментарии в Markdown, как показано в приведенном ниже синтаксисе:

Популярные приложения для Markdown поддерживают вышеуказанный метод.

Метод 5

Github также позволяет использовать следующий синтаксис для обозначения комментариев:

Хотя приведенный выше синтаксис не является общепринятым и используемым.

Заключение

В этом уроке вы узнали о пяти эффективных методах добавления комментариев в Markdown-комментарии.