Vim Instant Markdown用户需要使用

<!---
First comment line...
//
_NO_BLANK_LINES_ARE_ALLOWED_
//
_and_try_to_avoid_double_minuses_like_this_: --
//
last comment line.
-->

我相信，所有先前提出的解决方案（除了那些需要特定实现的解决方案）都会导致注释包含在输出HTML中，即使它们没有显示出来。

如果你想要一个完全属于你自己的评论（转换文档的读者应该看不到它，即使使用“查看源代码”），你可以（ab）使用核心Markdown规范中提供的链接标签（用于参考样式链接）：

http://daringfireball.net/projects/markdown/syntax#link

即：

[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)

为了实现最大的可移植性，在这种类型的注释前后插入一个空行是很重要的，因为某些Markdown解析器在定义碰到常规文本时无法正常工作。Babelmark的最新研究表明，前后空白行都很重要。如果前面没有空行，一些解析器将输出注释，如果后面没有空行则一些解析器将排除以下行。

通常，这种方法应该适用于大多数Markdown解析器，因为它是核心规范的一部分。（即使定义了多个链接时的行为，或定义了链接但从未使用时的行为也未严格指定）。

Vim Instant Markdown用户需要使用

<!---
First comment line...
//
_NO_BLANK_LINES_ARE_ALLOWED_
//
_and_try_to_avoid_double_minuses_like_this_: --
//
last comment line.
-->

披露：我写了这个插件。

由于问题没有指定特定的markdown实现，我想提到python markdown的Comments插件，它实现了上述相同的pandoc注释样式。

对于pandoc，一个阻止评论的好方法是使用yaml元块，正如pandoc作者所建议的那样。我注意到，至少在我的环境中（vim、vim-pandoc和vim-pandocsyntax），与许多其他建议的解决方案相比，这为注释提供了更恰当的语法高亮显示。

我将yaml块注释与html内联注释结合使用，因为html注释不能嵌套。不幸的是，在yaml元块中没有块注释的方法，所以每一行都必须单独注释。幸运的是，软包装的段落中应该只有一行。

在我的~/.vimrc中，我为块注释设置了自定义快捷方式：

nmap <Leader>b }o<Esc>O...<Esc>{ji#<Esc>O---<Esc>2<down>
nmap <Leader>v {jddx}kdd

我分别使用so、b和v注释和取消注释段落，作为我的<Leader>键。如果我需要注释多个段落，我将j，b映射到一个宏（通常为Q），然后运行＜段落数＞＜宏名＞（例如（3Q）。这同样适用于取消注释。

以下方法非常有效

<empty line>
[whatever comment text]::

该方法利用语法通过引用创建链接由于使用[1]创建了链接引用：http://example.org不会呈现，同样，以下任何内容也不会呈现

<empty line>
[whatever]::
[whatever]:whatever
[whatever]: :
[whatever]: whatever
[whatever]: # whatever with spaces