Markdown和PlantUML的基本使用

小飞将

已于 2023-09-11 17:14:02 修改

阅读量954

点赞数

分类专栏：基础文章标签： Markdown plantUML

于 2023-09-06 14:05:45 首次发布

本文链接：https://blog.csdn.net/u014786409/article/details/132713922

版权

基础专栏收录该内容

104 篇文章 5 订阅

订阅专栏

首先需要在VS Code中安装Markdown extention和plantUML插件

测试标题

这是测试标题，使用一个#号配合标题

测试1级标题

这是1级测试标题，使用2个#号配合标题

测试2级标题

这是2级测试标题，使用3个#号配合标题

这里是多级列表

Part A
1. Section One
  1. Example 1
  2. Example 2
2. Section Two
3. Section Three
Part B
- Section One
- Section Two
- Section Three
- Section Four
Part C
就是简单使用序号加.的英文句号，或者*/+/-加空格，如果有缩进，则使用TAB

接下来是插入图片测试，格式为：

![picture ID](图片路径 “picture name")

接下来是表格，用|分隔列，用-分隔行

| DDR |
| -------- |
| Signal_1 |
| Signal_2 |
| Signal_3 |
| Signal_N |

接下来进行代码测试code test，这是行内代码测试；使用键盘左上角数字1左边的 ’ 符号包括行内代码

接下来是代码块测试，以3个 ` 开头，后跟语言类型如 C++，代码块结尾以3个和开头一样的符号结尾

double func(int para) {
    return sqrt(para);
}

接下来是流程图测试，以3个 ` 开头，后跟plantuml以标识这里用到plantuml

@startuml

start

:prepare();

if (initSuccess()) then (true)
    :process();
else (false)
endif

stop

@enduml

接下来是时序图测试：

@startuml

Alice -> Bob: Get device info

Bob -> Alice: Device info

Alice -> Alice: Self test

@enduml

接下来是类图测试：

@startuml

SessionManager *-- ISession
ISession ^-- Session
Session --> Handle

SessionManager : GetDevInfo();
SessionManager : ISession[] sessionSet;

ISession : TxConfig();

Session : TxConfig();
Session : txHandle;
Session : rxHandles

Handle : read();
Handle : write();

@enduml

接下来是JSON格式测试：

```plantuml
@startjson
{
    "Slot1": {
        "funcType:CW": {
            "LO0Port0":{
                "Freq_1G":{
                    "Power_10dBm":{
                        "ElementList":[
                            "Element1","Element2","Element3","..."
                        ]
                    },
                    "Power_0dBm":{
                        "ElementList":[
                            "Element1","Element2","Element3","..."
                        ]
                    },
                    "Power_-10dBm":{
                        "ElementList":[
                            "Element1","Element2","Element3","..."
                        ]
                    }
                },
                "Freq_2G":{
                    "Power_10dBm":{
                        "ElementList":[
                            "Element1","Element2","Element3","..."
                        ]
                    },
                    "Power_0dBm":{
                        "ElementList":[
                            "Element1","Element2","Element3","..."
                        ]
                    },
                    "Power_-10dBm":{
                        "ElementList":[
                            "Element1","Element2","Element3","..."
                        ]
                    }
                }
            },
            "LO0Port4":{
                "Freq_1G":{
                    "Power_10dBm":{
                        "ElementList":[
                            "Element1","Element2","Element3","..."
                        ]
                    },
                    "Power_0dBm":{
                        "ElementList":[
                            "Element1","Element2","Element3","..."
                        ]
                    },
                    "Power_-10dBm":{
                        "ElementList":[
                            "Element1","Element2","Element3","..."
                        ]
                    }
                },
                "Freq_2G":{
                    "Power_10dBm":{
                        "ElementList":[
                            "Element1","Element2","Element3","..."
                        ]
                    },
                    "Power_0dBm":{
                        "ElementList":[
                            "Element1","Element2","Element3","..."
                        ]
                    },
                    "Power_-10dBm":{
                        "ElementList":[
                            "Element1","Element2","Element3","..."
                        ]
                    }
                }
            }
        },
        "funcType:DT": "...",
        "funcType:MOD": "..."
    },
    "Slot2":"...",
    "Slot10":"...",
    "Slot11":"..."
}
@endjson