用途:提供 PlantUML 图语法的权威参考资料,帮助用户用文本描述生成各类图表。PlantUML 是基于 Java 的工具,自 2009 年起使用,支持 15 种以上图表类型。
主要能力:支持 UML 图(时序图、用例图、类图、活动图、组件图、部署图、状态图)和非 UML 图(JSON、YAML、线框图、甘特图、思维导图、WBS、ER、C4)。提供语法模式、示例、C4 模型图标/精灵集成及大量自定义选项。
基本用法:所有图表用 @startuml 与 @enduml 包裹;注释单行用 ',块注释用 /' '/;可设置 title、caption、header、footer。非 UML 图使用对应关键字,如 @startjson、@startyaml、@startsalt、@startgantt、@startmindmap、@startwbs。文件扩展名可用 .puml、.plantuml、.pu,包含文件用 .iuml。参考文档包括 sequence.md、class.md、activity.md、state-component.md、c4.md、special-diagrams.md、styling-setup.md,按任务类型加载。
运行要求:需要 Java 运行时环境(JRE);部分图类型需要 GraphViz;也可用 Docker 运行:docker run -p 8080:8080 plantuml/plantuml-server。
适用场景:创建时序图、类图、C4 架构图等各类图表时提供语法与示例支持。限制:资料未提供收费与价格信息;部分内容依赖外部参考文档,具体细节暂未提供。