Skip to content
| Marketplace
Sign in
Visual Studio Code>Other>umlgenNew to Visual Studio Code? Get it now.
umlgen

umlgen

知春非花

|
1,296 installs
| (0) | Free
umlgen vscode extension
Installation
Launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter.
Copied to clipboard
More Info

vscode-umlgen README

功能

生成c++项目的plantuml类图源文件(*.wsd,可进一步利用PlantUml插件将源文件转为图片)。

注意事项

  • 仅支持在macOS使用
  • 适用场景
    此工具更适用于生成少数文件的类图,大型项目更推荐使用doxgen之类的工具。
  • 工具不支持模板类的输出。
    template< typename T > class B : public A< T > 输出的.wsd文件 不会有A和B的继承关系(B -|> A)

常规用法

  • 在资源管理器(explorer)中选中文件,右键菜单,运行umlgen
  • 选中编辑器(editor)内的某个类名,右键菜单运行umlgen,生成和此类相关的.wsd文件

提示:

  • 生成的.wsd文件路径 path/to/this/file.wsd(同名文件后面加数字区分),若已安装PlantUml的用户可右键此文件运行Export Workspace Diagrams选择导出图片。

高级用法

如果你遇到如下问题,可尝试使用高级用法解决:

  1. 类之间的继承关系不显示:

常规用法不提供构建信息(build_path),可能导致无法关联头文件,进而出现以下问题:
class A : public B
A、B 通过include关联,关联失败导致最后的输出无法体现它们的继承关系。
2. 输出的类太多,导致最后的类图太过庞大:

可在高级用法下输入正则表达式,匹配你需要的类名(带命名空间)。

提示:

  • build_path可以是cmake的构建目录compile_commands.json,通过cmake参数 -DCMAKE_EXPORT_COMPILE_COMMANDS=On生成。
  • 正则表达式筛选时带命名空间,如: class test::A需用*A匹配

使用方法

在资源管理器(explorer)中选中文件,右键菜单,运行umlgen advanced

  • 可选择输入build_path的绝对路径,不输入内容表示不设置
  • 可选择输入正则表达式(class_regular_expression)来筛选你想要展示的类,不输入内容表示筛取全部类

设置选项

  • umlgen.optV: 展示成员的类别,默认只展示public成员
  • umlgen.Not-search-base: 不寻找选中类的基类
  • umlgen.Not-search-sub: 不寻找选中类的子类
  • Contact us
  • Jobs
  • Privacy
  • Manage cookies
  • Terms of use
  • Trademarks
© 2025 Microsoft