PlantUML插件本身不自动扫描项目生成类图,仅渲染手动编写的.puml文本;需配合pyreverse等工具实现代码反向工程,而设计建模则直接用class、+/-/#修饰符和标准关系符号在@startuml/@enduml内编写,Alt+D预览,支持本地或云端渲染。

PlantUML 插件本身不自动扫描 Python 或 Java 项目生成类图——它只渲染你手动写的 .puml 文本。想“一键生成”项目结构图,得靠额外工具链配合,而不是仅装个插件就完事。
VSCode 里怎么用 PlantUML 手动写类图?
这是最轻量、最可控的方式,适合设计阶段快速建模或文档配图。
-
@startuml和@enduml是必需的包裹标记,缺一不可 - 类定义用
class ClassName,属性/方法前加+(public)、-(private)、#(protected) - 关系符号必须严格匹配语义:
表示继承,<code>*--表示组合,o--表示聚合,..>表示依赖 - 保存为
.puml后缀文件后,按Alt+D预览;导出 PNG/SVG 用Ctrl+Shift+P→PlantUML: Export Current Diagram - 常见报错
Cannot find Graphviz dot command意味着本地渲染失败,此时可临时切换为云端渲染(插件设置里关掉plantuml.render的本地模式)
想从 Python 代码自动生成类图,该用哪个工具?
直接在 VSCode 里“一键生成”的核心是 pyreverse(来自 pylint),不是 PlantUML 插件本身。
- 先确保已安装:
pip install pylint(自带pyreverse) +graphviz(系统级,不是 pip 包) - 在 VSCode 终端执行:
pyreverse -o png -p myproject myproject/,会生成classes.png和packages.png - 若提示
dot: command not found,说明graphviz的dot命令没进 PATH;Windows 用户要手动把C:\Program Files\Graphviz\bin加入系统环境变量 - 生成的 PNG 是静态图,不支持交互或实时更新;如需嵌入文档,建议用脚本自动触发并拷贝到
docs/目录
为什么 PlantUML Visualizer 插件比官方 PlantUML 更适合新手?
因为它绕过了 Java + Graphviz + plantuml.jar 三重依赖,直接调用远程渲染服务。
- 安装后新建
demo.puml,输入任意合法语法,Alt+D就能秒出图,完全不用配置 - 不依赖本地
dot,也就不会遇到Graphviz not found或Java version mismatch这类错误 - 但企业内网可能屏蔽其 API(
https://www.plantuml.com/plantuml/),此时必须退回官方插件 + 本地 Graphviz 方案 - 导出 SVG 时注意:远程渲染的 SVG 不含字体嵌入,换设备打开可能乱码;如需交付,优先导出 PNG 或用本地渲染


















