評論中太多朋友在問,我的文章中圖例如何完成的。
我一直用plantUML,也推薦大家用,下面給出一個簡潔的PlantUML教程。
🌱 什么是 PlantUML?
PlantUML 是一個用純文本語言畫圖的工具,支持流程圖、時序圖、用例圖、類圖、組件圖、狀態圖等。它適合開發人員用來快速寫文檔或可視化設計。
?? 基本語法結構
每個圖都從 @startuml
開始,以 @enduml
結束:
@startuml
// 你的圖內容
@enduml
🔹 示例 1:時序圖(Sequence Diagram)
@startuml
Alice -> Bob: Hello Bob
Bob --> Alice: Hi Alice
@enduml
🔹 效果:顯示 Alice 向 Bob 發消息,Bob 回復 Alice。
🔹 示例 2:用例圖(Use Case)
@startuml
actor User
User --> (Login)
User --> (Upload File)
@enduml
🔹 效果:用戶能執行登錄和上傳文件的用例。
🔹 示例 3:類圖(Class Diagram)
@startuml
class Car {+start()+stop()-engine
}class EngineCar --> Engine : uses
@enduml
🔹 效果:Car
類使用 Engine
類,有公開方法和私有成員。
🔹 示例 4:流程圖(Activity Diagram)
@startuml
start
:Login;
if (Valid?) then (yes):Show Dashboard;
else (no):Show Error;
endif
stop
@enduml
🔹 效果:登錄流程圖,成功進入主界面,失敗顯示錯誤。
?? 如何運行?
你可以用以下方式使用 PlantUML:
-
在線編輯器:
-
PlantUML Web Server
-
只需粘貼代碼即可看到圖像。
-
-
本地使用:
-
安裝 Java 和 PlantUML JAR 文件
-
用命令運行:
java -jar plantuml.jar yourfile.puml
-
-
IDE 插件:
-
VSCode:安裝 PlantUML 插件
-
IntelliJ:安裝 PlantUML Integration 插件
-
VSCode:使用markdown, 在markdown預覽插件中,配置還是需要提前安裝
plantuml.jar,這是我比較喜歡的方式。
-
🎯 常用圖類型
圖類型 | 關鍵詞 |
---|---|
時序圖 | sequence |
用例圖 | usecase |
類圖 | class |
活動圖/流程圖 | activity |
狀態圖 | state |
組件圖 | component |
時態圖 | deployment |
歡迎在評論區交流使用心得!