供链-产品手册

技术团队文档示例


plantuml支持

<p>showdoc支持plantuml,包括时序图、用例图、类图、组件图、状态图等等。你可以使用markdown代码块声明plantuml,然后中间插入plantuml语句。如:</p> <pre> ```plantuml @startuml Alice -> Bob: Authentication Request Bob --> Alice: Authentication Response Alice -> Bob: Another authentication Request Alice <-- Bob: another authentication Response @enduml ``` </pre> <p>上述代码生成的图例效果如下:</p> <pre><code class="language-plantuml"> @startuml Alice -&gt; Bob: Authentication Request Bob --&gt; Alice: Authentication Response Alice -&gt; Bob: Another authentication Request Alice &lt;-- Bob: another authentication Response @enduml </code></pre> <h4>更多plantuml语法规则请看https://plantuml.com/zh</h4> <h4>下方将给出各个图的预览效果</h4> <hr /> <h3>时序图</h3> <pre><code class="language-plantuml"> @startuml Alice -&gt; Bob: Authentication Request Bob --&gt; Alice: Authentication Response Alice -&gt; Bob: Another authentication Request Alice &lt;-- Bob: another authentication Response @enduml </code></pre> <h3>用例图</h3> <pre><code class="language-plantuml"> @startuml (First usecase) (Another usecase) as (UC2) usecase UC3 usecase (Last\nusecase) as UC4 @enduml </code></pre> <h3>类图</h3> <pre><code class="language-plantuml"> @startuml Class01 &lt;|-- Class02 Class03 *-- Class04 Class05 o-- Class06 Class07 .. Class08 Class09 -- Class10 @enduml </code></pre> <h3>活动图</h3> <pre><code class="language-plantuml"> @startuml (*) --&gt; "First Activity" "First Activity" --&gt; (*) @enduml </code></pre> <h3>组件图</h3> <pre><code class="language-plantuml"> @startuml [First component] [Another component] as Comp2 component Comp3 component [Last\ncomponent] as Comp4 @enduml </code></pre> <h3>状态图</h3> <pre><code class="language-plantuml"> @startuml [*] --&gt; State1 State1 --&gt; [*] State1 : this is a string State1 : this is another string State1 -&gt; State2 State2 --&gt; [*] @enduml </code></pre> <h3>定时图</h3> <pre><code class="language-plantuml"> @startuml robust "Web 浏览器" as WB concise "Web 用户" as WU @0 WU is 空闲 WB is 空闲 @100 WU is 等待中 WB is 处理中 @300 WB is 等待中 @enduml </code></pre>

页面列表

ITEM_HTML