如何在Markdown中撰写评论- pachoyan - Medium
Markdown是一种非常简单的标记语言,专注于使用简单的文本编辑器创建格式化文本。
与任何其他标记语言一样,为了获得美观的输出,需要一个渲染/处理器来读取 Markdown 文件并显示它。这就是为什么根据您阅读 Markdown 的位置,它可能看起来不同或具有不同的输出,因为是处理器决定文件的外观。
与解释器/编译器一样,包含指令并由处理器负责显示的 Markdown 文件(例如 Readme.md)。例如,在Python中,Python脚本文件由Python解释器解释以执行。 免责声明
这是关于Markdown显示方式的一个非常简单的描述,实际情况可能有所不同。
Markdown图表
问题在于大多数Markdown处理器中没有这样的指示,告知一行是注释。
我们如何编写注释?
欺骗解释器。
什么是注释 #
注释是一个标记行,通常不被评估,用于提供可读的解释。
注释在编程中非常常见,可以在大多数编程语言(Java,Python,Rust等)或者配置文件如YAML或TOML中使用。
例如,在Java中
// 这是一个注释
或者在YAML中
# 这是一个注释
如何在Markdown中编写注释 #
在Markdown中写注释实际上是不可能的。Markdown规范没有一种标准的添加注释的方式。
显然,根据之前我解释的文件处理器的原则,你可以欺骗。 免责声明
此处描述的示例可能不适用于所有渲染器。
标准 HTML 注释标签 #
<!--- 这是一个注释 -->
链接的样式 #
[comment]: # (这是一个注释)
[//]: # (这是一个注释)
或者只是一个单词
[comment]: comment
测试 #
如果您进入https://markdownlivepreview.com/ (opens new window)并测试
<!--- 这是一个注释 -->[comment]: # (这是一个注释)[//]: # (这是一个注释)[comment]: comment
您将看到没有输出显示。您可以尝试不同的渲染器,看看它们是否显示,因为某些选项在不同的Markdown应用程序上可能有不同的工作方式。