使用mkdocs时，添加mkdocs.yml：

  - pymdownx.striphtml:
      strip_comments: true
      strip_js_on_attributes: false

然后在任何markdown文件中使用普通的html注释，如

<!-- this is a comment -->

将从html输出中删除。

您可以这样做（YAML块）：

~~~
# This is a
# multiline
# comment
...

我只尝试了乳胶输出，请为其他人确认。

如果它在VS代码中，那么还有另一个好选项：

<span hidden> Some texts </span>

与“HTML注释标记”相比，它具有在编辑区域保持语法高亮显示的优势，以及为语义标记添加属性的能力，如＜span notice hidden＞。

警告：根据常识，不要在源代码中包含个人信息。

我使用标准的HTML标记，例如

<!---
your comment goes here
and here
-->

注意三点划线。其优点是，在生成TeX或HTML输出时，它可以与pandoc一起工作。有关更多信息，请访问pandoc讨论组。

这在GitHub上有效：

[](Comment text goes here)

生成的HTML如下所示：

<a href="Comment%20text%20goes%20here"></a>

这基本上是一个空链接。显然，您可以在渲染文本的源代码中阅读，但无论如何您都可以在GitHub上阅读。

对于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）。这同样适用于取消注释。