Rust注释支持markdown语法,本节介绍一下Markdown 标题、段落、列表、标题、公式、图片、超链接、上下标、甘特图、流程图、选择框等语法。
文章目录
- [1、 标题](#1、 标题)
- 2、段落
- [3、 字体](#3、 字体)
- [4、 列表](#4、 列表)
- [5、 分隔线](#5、 分隔线)
- 6、表格
- 7、代码
- 8、引用
- 9、任务列表
- 10、链接
-
- 10.1、行内形式
- [10.2 参考形式](#10.2 参考形式)
- 11、图片
1、 标题
Markdown使用#符号表示标题,其中#号必须在行首,后面必须跟空格。#的数量表示标题的级别。例如:
# 一号标题
## 二号标题
### 三号标题
#### 四号标题
##### 五号标题
###### 六号标题
效果如下
注意,还可以使用3个"="和3个"-"分别表示一级和二级标题,这种表方法用的少。例如:
一级标题
===
二级标题
---
效果如下
2、段落
段落的换行通常需要使用两个空格加上回车,或者在文本之间添加一个空行。
3、 字体
3.1、斜体
使用一个*或_将内容包起来,如*斜体文本*或_斜体文本_:斜体文本。
3.2、粗体
使用两个**或__将内容包起来,如 **粗体文本**或__粗体文本__: 粗体文本。
3.3、粗斜体
使用三个***或___将内容包起来,如***粗斜体文本***或___粗斜体文本___:粗斜体文本
3.4、 删除线
使用两个~~将内容包起来,如~~删除线文本~~:删除线文本。
4、 列表
4.1、无序列表
使用*、+或-符号加上空格来表示,如:
+ 项目1
+ 项目2
+ 项目3
效果如下:
- 项目1
- 项目2
- 项目3
4.2、 有序列表
使用数字加.符号来表示,如:
1. 项目1
2. 项目2
3. 项目3
效果如下:
- 项目1
- 项目2
- 项目3
4.3、列表嵌套
列表还可以进行嵌套,通过在子列表项前添加额外的空格或Tab键来实现。如:
- 项目1
- 嵌套1
- 嵌套2
- 再嵌套
- 项目2
效果如下
- 项目1
- 嵌套1
- 嵌套2
- 再嵌套
- 项目2
5、 分隔线
Markdown中可以使用三个或以上的*、-或_来表示分隔线,我推荐用下划线_为佳,因为粗斜体用到*、二级标题用到 -。_表示如下:
___
效果:
6、表格
Markdown中的表格使用|来分隔不同的单元格,使用-来分隔表头和其他行,用:表示文字对齐方式。如:
| 表头1 | 表头2 |表头3 |
| ---- | :---- |----:|
| 居中对齐 | 左对齐 |右对齐|
| 1 | 2 |3|
效果如下:
表头1 | 表头2 | 表头3 |
---|---|---|
居中对齐 | 左对齐 | 右对齐 |
1 | 2 | 3 |
7、代码
7.1、单行代码
使用反引号`将代码包裹起来,如:
`print('Hello World!')`。
7.2、代码区块
使用三个反引号```````````包裹一段代码,并可以指定语言。
8、引用
Markdown使用>符号来表示引用,如:
> 这是一个引用
>> 这是一个嵌套的引用
效果如下:
这是一个引用
这是一个嵌套的引用
9、任务列表
使用- [ ]表示未完成的任务,使用- [x]表示已完成的任务,如:
- [ ] 任务1
- [x] 任务2
效果如下:
- 任务1
- 任务2
10、链接
Markdown支持两种形式的链接:
10.1、行内形式
如
[链接文字](链接地址 "标题"),如[百度](https://www.baidu.com "百度首页")
10.2 参考形式
如
[链接文字][链接名称],然后在文档末尾添加[链接名称]: 链接地址 "标题",如[百度][1]和[1]: https://www.baidu.com "百度首页"。
11、图片
插入图片的语法与链接类似,但需要在前面加上一个!,如:
![图片描述](图片地址 "图片标题")
或者使用参考形式:
![图片描述][图片名称]
[图片名称]: 图片地址 "图片标题"