在Markdown中写注释

概述

下面是我整理的在Markdown中写注释的几种方法,供本身开发时参考,相信对其余人也有用。html

html标签

既然Markdown内嵌html语法,那么就能够用能够用隐藏的html标签。浏览器

注意:须要在前面空一行markdown

<div style='display: none'>
哈哈我是注释,不会在浏览器中显示。
我也是注释。
</div>

html注释

既然支持html语法,那也支持html注释。测试

<!--哈哈我是注释,不会在浏览器中显示。-->

<!--
哈哈我是多段
注释,
不会在浏览器中显示。
-->

hack方法

hack方法就是利用markdown的解析原理来实现注释的。spa

通常有的markdown解析器不支持上面的注释方法,这个时候就能够用hack方法。code

hack方法比上面2种方法稳定得多,可是语义化太差。htm

[comment]: <> (哈哈我是注释,不会在浏览器中显示。)
[comment]: <> (哈哈我是注释,不会在浏览器中显示。)
[comment]: <> (哈哈我是注释,不会在浏览器中显示。)
[//]: <> (哈哈我是注释,不会在浏览器中显示。)
[//]: # (哈哈我是注释,不会在浏览器中显示。)

其中,这种方法最稳定,适用性最强:开发

[//]: # (哈哈我是注释,不会在浏览器中显示。)

这种方法最可爱,超级无敌萌啊:原理

[^_^]: # (哈哈我是注释,不会在浏览器中显示。)

示例测试

1.html标签(你若是看不到下面的注释说明已经成功注释)hack

<div style='display: none'> 哈哈我是注释,不会在浏览器中显示。 我也是注释。 </div>

2.html注释(你若是看不到下面的注释说明已经成功注释)

<!--哈哈我是注释,不会在浏览器中显示。-->

<!-- 哈哈我是多段 注释, 不会在浏览器中显示。 -->

3.hack注释(你若是看不到下面的注释说明已经成功注释)

相关文章
相关标签/搜索