小编典典

如何在 Markdown 中编写注释

javascript

如何在 Markdown 中编写注释,即未在 HTML 输出中呈现的文本?我在Markdown 项目上一无所获。


阅读 629

收藏
2022-02-16

共2个答案

小编典典

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

如果您想要一个完全属于您自己的评论(转换后的文档的读者应该看不到它,即使使用“查看源代码”),您可以(ab)使用链接标签(用于参考样式链接)在核心 Markdown 规范中可用:

那是:

[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 解析器,因为它是核心规范的一部分。(即使定义了多个链接时的行为,或者定义了链接但从未使用过的行为,也没有严格指定)。

2022-02-16
小编典典

我使用标准的 HTML 标签,比如

<!---
your comment goes here
and here
-->
2022-02-16