一、Markdown時序圖語法
Markdown時序圖語法由多個符號和關鍵片語成。主要包含下面幾個要素:
- participant: 定義參與者,格式為participant [參與者名稱]。示例:participant 用戶
- activate: 使參與者進入激活狀態,格式為[參與者名稱] ->+ activate。示例:用戶 ->+ activate
- deactivate: 使參與者離開激活狀態,格式為[參與者名稱] ->- deactivate。示例:用戶 ->- deactivate
- note: 添加註釋,格式為Note right of [參與者名稱]: 注釋內容。示例:Note right of 用戶: 用戶輸入
- message: 發送消息,格式為[參與者名稱1] –> [參與者名稱2]: 消息內容。示例:用戶 –> 系統:登錄
- return: 返回消息,格式為[參與者名稱1] –>> [參與者名稱2]: 消息內容。示例:用戶 –>> 系統:登錄成功
示例代碼如下:
participant 用戶 participant 系統 用戶 ->+ activate Note right of 用戶: 用戶輸入 系統 --> 用戶: 驗證信息 用戶 -->> 系統: 登錄請求 系統 -->> 用戶: 登錄成功
二、Markdown畫時序圖
Markdown時序圖可以用多種工具來繪製。常用的工具包括:WebSequenceDiagrams、PlantUML、Mermaid等。
以WebSequenceDiagrams為例,可以按照上面介紹的語法來進行繪製。在網站上選擇”Markdown”語言後,輸入代碼即可生成時序圖。示例代碼如下:
participant 用戶 participant 系統 用戶 ->+ activate Note right of 用戶: 用戶輸入 系統 --> 用戶: 驗證信息 用戶 -->> 系統: 登錄請求 系統 -->> 用戶: 登錄成功
生成的時序圖如下:
三、Markdown圖片代替文字
時序圖中可以使用圖片代替文字,使得圖示更加直觀。具體步驟如下:
- 準備好需要代替的圖片
- 將圖片上傳到互聯網上,獲取其URL
- 在Markdown時序圖語法中使用”image”關鍵字,格式為[參與者名稱1] [參與者名稱2]。示例:用戶 系統
四、Markdown語法序號
在Markdown中,可以使用”#”符號來添加序號,表示標題等級。示例:
# 一級標題 ## 二級標題 ### 三級標題 #### 四級標題 ##### 五級標題 ###### 六級標題
效果如下:
一級標題
二級標題
三級標題
四級標題
五級標題
六級標題
五、Markdown流程圖語法
除了時序圖外,Markdown還支持流程圖語法。具體語法及代碼示例,請見Mermaid官網。
六、Markdown標題序號
在Markdown中,可以通過添加”[TOC]”來自動生成標題序號。示例代碼如下:
# Markdown標題 ## 目錄 [TOC] ## 一級標題 ### 二級標題 #### 三級標題 ##### 四級標題
七、Markdown無序列表
在Markdown中,可以使用”-“符號來添加無序列表,示例:
- 列表項1 - 列表項2 - 列表項3
- 列表項1
- 列表項2
- 列表項3
八、Markdown流程圖
使用Mermaid語法可以繪製流程圖,示例代碼如下:
graph TD; A-->B; A-->C; B-->D; C-->D; D-->E;
生成的流程圖如下:
總結
Markdown時序圖是一種直觀且易於閱讀的表達方式,我們可以通過多種工具來實現時序圖的繪製。除此之外,在Markdown中還有許多其他有用的語法和方法,如標題序號、無序列表、流程圖等。通過熟練掌握這些語法,我們可以更好地編寫文字和圖形內容,讓信息更加清晰明了。
原創文章,作者:小藍,如若轉載,請註明出處:https://www.506064.com/zh-tw/n/185882.html