Markdown Toolbox Logo Markdown Toolbox
家
博客

如何在markdown中添加评论？

2024-09-02

简短版本

Markdown 本身不支持评论。请改用 HTML 注释。

<!-- 这是一个评论 -->

长版本

介绍

虽然 Markdown 非常适合创建格式化文本，但它并没有内置的评论功能。不过，您仍然可以通过使用 HTML 注释元素来添加评论。

在 Markdown 中添加评论

要在您的 Markdown 文件中添加评论，只需使用 HTML 注释语法。在 <!-- 和 --> 之间写的任何内容在渲染时都会被忽略：

<!-- 这个评论将不会出现在输出中 -->

您可以在文档中的任何地方添加评论，而不会影响输出内容。

结论

在 Markdown 中添加评论，使用 HTML 注释仍然是最佳方法。这样，您可以在原始 Markdown 中包含注释和解释，而不会出现在最终文档中。