1. 前言
在任何一款现代程序语言中,注释都是至关重要的,它是源代码文件提升可读性的重要补充,也是多人协作时的重要工具。
Markdown 的注释可以通过三种方法实现:第一是通过 html 的 <!-- -->
标记;第二可以通过样式隐藏段落内容,即 <div style="display:none">
;第三是通过 Markdown 自身的解析原理实现。
环境说明:
考虑到 Markdown 工具之间的不兼容,有的内容直接从页面复制粘贴到本地不会正常显示,大家学习时自己动手写是肯定没问题的。本节所有实例代码及演示效果均使用 Typora 工具完成。
本节所有截图均为 Typora 导出 HTML 后网页的渲染效果。
2. 语法详解
2.1 使用原生 HTML 注释语法
因为 Markdown 文档是基于 HTML 实现的,所以可以通过 HTML 原生对注释的支持实现文档注释效果。
实例 1:
#### 基于 HTML 标签的注释
<!-- 这是一段被注释掉的文字 -->
这是一段没有被注释的文字
其渲染结果如下: