Markdown 注释

Markdown 注释语法

在 Markdown 中，如果想要在源代码某些位置中添加说明，但又不希望这些内容在页面中渲染出来，此时就可以使用注释的方式来实现。

Markdown 官方并没有提供注释语法，但由于 Markdown 代码最终会转换为 HTML 代码，因此我们可以使用 “HTML 注释” 的语法来实现注释的目的。

语法：

<!--注释内容-->

说明：

​ “<!--” 表示注释的开始，“-->” 表示注释的结束，然后需要注释的内容放在 “<!--” 和 “-->” 之间。注释的内容可以是一行，也可以是多行。

任何放在 “<!--” 和 “-->” 之间的内容都不会在 Markdown 文档的最终渲染结果显示出来。

Markdown 注释示例

接下来，我们通过几个简单的例子来介绍一下 Markdown 是如何使用注释的。

示例 1：单行注释

<!--这是注释内容-->
绿叶网 - 为好教程，全力以赴

渲染效果如下图所示。

生成 HTML 代码如下。

<!--这是注释内容-->
<p>绿叶网 - 为好教程，全力以赴</p>

示例 2：多行注释

<!--
    这是注释内容
    这是注释内容
    这是注释内容
-->
绿叶网 - 为好教程，全力以赴

渲染效果如下图所示。

生成 HTML 代码如下。

<!--
    这是注释内容
    这是注释内容
    这是注释内容
-->
<p>绿叶网 - 为好教程，全力以赴</p>

分析：

从上面两个例子的渲染效果可以看出，不管 “<!--” 和 “-->” 之间包含多少内容，最终都不会在渲染结果中显示出来。

最后需要注意的是，虽然 HTML 注释在页面上不可见，但它们仍然存在于 HTML 源代码中。因此我们一定不能在注释中编写敏感信息（如密码、密钥等），因为其他人可以通过 “查看网页源代码” 的方式来看到。

如果不希望注释出现在生成的 HTML 源码中，我们可以使用以下兼容性更好的 “黑客写法”：

[//]: # (这是一个不会出现在 HTML 源码中的注释)

上面这种方式，本质上是将其解析为一个不显示的链接锚点。