如何使用Markdown写注释

写代码你可以注释,不需要处理的代码就 comment out。写 Markdown 呢?一篇文章写出来,总是有点草稿的,每次都忍痛割爱删掉,可能下次还要再敲一遍。” 这个是引用一个老哥的一句话。今天我就遇到了这个情况,因此和大家一起学习一下 markdwon 注解

html 标签

  既然 Markdown 内嵌 html 语法,那么就可以用可以用隐藏的 html 标签。

  注意:需要在前面空一行

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

html 注释

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

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

hack 方法

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

  一般有的 markdown 解析器不支持上面的注释方法,这个时候就可以用 hack 方法。

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

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

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

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

  这种方法最可爱,超级无敌萌啊,一下子就打动了老夫:

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

  也可以这样写:

1
[^_^]:    哈哈我是多段    注释,    不会在浏览器中显示。

  亲测可用(Pandoc、GitHub、简书、作业部落)。十分完美,除了这个 warning:

1
pandoc: Duplicate note reference `^' "source" (line 85, column 1)

示例测试

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

  哈哈我是注释,不会在浏览器中显示。 我也是注释。

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

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