Markdown 要注释还要萌

[zhidian]

代码可以注释，不要的代码可以先 comment out 。 写 Markdown 呢？一篇文章写出来，总是有点草稿的，每次都忍痛割爱删掉，可能下次还要再敲一遍。 所以我一般都写到某个特定的 class 的 div 里，再用 CSS 把它们隐藏。

可惜这种方法既不优雅也不通用。

刚搜了一下：syntax - Comments in Markdown - Stack Overflow。

你可以用下面这些：

[comment]: <> (This is a comment, it will not be included)
[comment]: <> (in  the output file unless you use it in)
[comment]: <> (a reference style link.)
[//]: <> (This is also a comment.)
[//]: # (This may be the most platform independent comment)

我决定以后用：

[^_^]:
    commentted-out contents
    should be shift to right by four spaces (vim ：`>>`).

亲测可用（ Pandoc 、 GitHub 、简书、作业部落）。

如果你想测试一下你的 Markdown 能不能这么用，这是一点测试的文字：

a

[^_^]:
    b

c

d

显示的 a c d 应当间隔一样长。

不是每种 Markdown 都能注释多行文字，测试代码：

a

[^_^]:
    b
    
    c

d

效果：

a

c

d

v2ex 似乎无力了……（在我自己用的 pandoc 下，只有 a 和 d 这两行。）

我还试了 Pandoc、GitHub、简书和作业部落对此的支持，放在了这里 多行代码注释-简书 - 简书。

[zwh8800]

厉害了，这个评论怎么算结束？空行吗？

[zhidian]

@zwh8800 前后都要一个空行。

其实 Comment 里面也可以空行，只要空行之后的内容也缩进过（不过这个不通用，刚试了一下 pandoc 可以，简书的不可以。）

[yoke123]

好像不能多行注释 必须另起一行

[zhidian]

Pandoc 可以（ O ）， GitHub 不可以（ X ），简书不可以（ X ），作业部落可以（ O ）。其他的，大家自己试吧 ==。不能注释多行确实很麻烦。

[zhidian]

测试：[多行代码注释-简书 /作业部落， etc]( http://www.jianshu.com/p/f46bd33aafa4 )

[yzhen123]

直接使用 html 注释兼容大部分 markdown 解析器 <!-- 注释 -->

[zhujinliang]

以后要用注释开车么？

[zhidian]

@yzhen123 有道理。除了生成的 html 这个注释还在之外。

[sox]

@zhidian 可是不会显示啊。。

[zhidian]

@sox 我不知道为什么我忘了可以用 html 的注释……现在在忏悔。

或许是最近都是 markdown 转到 docx （用 pandoc ），直觉上 html 那种注释没用。不过刚才发现……也可以用。

所以我也不知道为啥自己饶了这么一个圈子。

[Mutoo]

@zhidian comment 的特点是 compile 完不会生成到最终产品里去，<!--会生成，只是不显示而已-->

[gaocegege]

=.= 萌

[xpol]

<!-- This is the right way to write markdown comment -->

[ioiioi]

看到这里我又忍不住推荐 asciidoc ，这货的功能比 markdown 强大多了。注释、表格、图像、 callout 、复杂列表等等都是原生支持的。而且很容易扩展。

[zhidian]

@ioiioi 看到了“ include::chapter1.txt[]”，似乎不错。现在我 Markdown 引入别的文件都是先用脚本过一遍拼起来……正纠结自己应该用 org-mode 还是 asciidoc 。

[zhidian]

看了下 [7. 附录：轻量级标记语言 — GotGitHub]( http://www.worldhello.net/gotgithub/appendix/markups.html ) 决定上 org-mode 了。

[SilentDepth]

这个好，还可以根据写注释时的心情决定标记以微笑脸还是严肃脸还是纠结脸，「颜文」并茂

[delogn]

[^_^]:
1

[>_<]:
2

[>_>]:
3

都可以用啊，不错不错！以后吐槽和心情都可以写在注释里了！

[justyy]

自己弄了一个在线 format Markdown 的工具，
亲测了上面的 comment 有效
https://helloacm.com/markdown/