Markdown中的评论 | 易学教程

【推荐】2019 Java 开发者跳槽指南.pdf(吐血整理) >>>

将注释存储在markdown文件中的语法是什么，例如文件顶部的CVS $ Id $注释？降价项目我什么都没发现。

#1楼

披露：我写了插件。

由于问题没有指定特定的降价实现，我想提及python-markdown的Comments插件，它实现了上面提到的相同的pandoc评论风格。

#2楼

我相信所有先前提出的解决方案（除了需要特定实现的解决方案之外）导致注释包含在输出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解析器，因为它是核心规范的一部分。（即使定义了多个链接时的行为，或者定义了链接但从未使用过时，也未严格指定）。

#3楼

另请参阅Critic Markup，由越来越多的Markdown工具提供支持。

http://criticmarkup.com/

Comment {>> <<}

Lorem ipsum dolor sit amet.{>>This is a comment<<}

Highlight+Comment {== ==}{>> <<}

Lorem ipsum dolor sit amet, consectetur adipiscing elit. {==Vestibulum at orci magna. Phasellus augue justo, sodales eu pulvinar ac, vulputate eget nulla.==}{>>confusing<<} Mauris massa sem, tempor sed cursus et, semper tincidunt lacus.

#4楼

如果您正在使用Jekyll或octopress，也可以使用。

{% comment %} 
    These commments will not include inside the source.
{% endcomment %}

首先解析Liquid标签{% comment %} ，然后在MarkDown处理器进入之前将其删除。访问者在尝试从浏览器中查看源时将看不到。

#5楼

这适用于GitHub：

[](Comment text goes here)

生成的HTML看起来像：

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

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

来源：oschina

链接：https://my.oschina.net/u/3797416/blog/3148092

标签

Markdown

octopress

pandoc

Python-Markdown