开发写文档常用的
内容包括:
转义字符、时序图、流程图、表格
1.Markdown显示转义字符
可以用4个反引号
2.时序图
对应输入如下:
```mermaid
sequenceDiagram
participant 校准软件
participant 万用表
participant 工装
校准软件->>工装: 1-设置工装
校准软件->>万用表: 2-连接万用表
校准软件->>万用表: 3-发送:设置量程
```
3.表格
对应输入如下:
| 工具 | 版本号 | 下载 |
| ------------- | ------ | ------------------------------------------------------------ |
| JDK | 1.8 | https://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html |
| MySQL | 5.7 | https://www.mysql.com/ |
| Redis | 7.0 | https://redis.io/download |
| MongoDB | 5.0 | https://www.mongodb.com/download-center |
| RabbitMQ | 3.10.5 | http://www.rabbitmq.com/download.html |
| Nginx | 1.22 | http://nginx.org/en/download.html |
| Elasticsearch | 7.17.3 | https://www.elastic.co/downloads/elasticsearch |
| Logstash | 7.17.3 | https://www.elastic.co/cn/downloads/logstash |
| Kibana | 7.17.3 | https://www.elastic.co/cn/downloads/kibana
4.流程图
对应输入:
``` mermaid
graph TB
A[登录 MainActivity] -->B[输入用户名和密码]
A[登录 MainActivity] -->E[注册账户 CreatAccount]
E -->F[输入注册信息]
F -->G{获取用户输入 发送到到后台判断用户是否存在}
G-->|用户不存在|H[信息上传后台保存 注册成功]
H-->|注册成功登录|B[输入用户名和密码]
G-->|用户存在|B[输入用户名和密码]
B -->C{获取用户输入的信息发送到后台获取结果进行对比}
C -->|信息正确|D[进入主页 HomeAge]
C -->|信息错误 请重新输入|B[输入用户名和密码]
C -.->|提示用户不存在 先注册账户|E[注册账户 CreatAccount]
D[进入主页 HomeAge]--> I[首页]
D[进入主页 HomeAge]--> J[商品]
D[进入主页 HomeAge]--> K[订单]
D[进入主页 HomeAge]--> L[营销]
D[进入主页 HomeAge]--> M[订单权限]
I[首页]-->N[仪表盘]
I[首页]-->O[学习教程]
I[首页]-->P[视频教程]
J[商品]-->Q[商品列表]
J[商品]-->R[添加商品]
J[商品]-->S[商品分类]
J[商品]-->T[商品类型]
J[商品]-->U[品牌管理]
```