【Godot4.2】用PlantUML和语雀画UML类图

news2025/2/25 22:03:23

概述

  • UML：统一建模语言(Unified Modeling Language,UML)是用来设计软件的可视化建模语言。
  • PlantUML：是一个开源工具，它允许我们用文本形式来描绘和创建UML图。在VSCode中可以安装扩展来绘制，而在语雀的MarkDown编辑器中，则可以用“文本绘图”形式直接在文档中创建。
  • UML类图：在面向对象语言或开发中类图是最基础也最有用的一种图，它可以描述类的成员以及多个类之间的关系。

在Godot中，我们使用GDScript进行开发时，也需要涉及类、继承、组合等。所以本篇就介绍一下如何在使用Godot编写类库或者进行OOP开发时，进行类图的绘制，用于详实自己的文档，并让人更好的看懂你的设计思路。

在语雀中创建PlantUML类图

在语雀文档中，在任意一行行首输入“/wbht”，可以找到“文本绘图”，回车即可插入“文本绘图”的Block。
image.png
默认插入的“文本绘图”块如下：
image.png
点击顶部的“模板”，在下拉列表中选择“类图”：
image.png
会自动填充和渲染一个如下的类图：
image.png
我们便可以在这个基础上进行UML类图的绘制。

PlantUML类图基础语法

起止标记

首先是起止标记，绘图描述的内容必须包裹在一对@startuml和@enduml标记之间。

@startuml

@enduml

申明元素

在@startuml和@enduml标记之间，我们可以使用特定的语法来申明类图的元素。PlantUML本身支持很多种元素申明，详见：类图的语法和功能
但在GDScript中最常用到的便是类和枚举，其他的元素类型并不支持。

@startuml
class a
enum skills
@enduml

其中：

  • 以class为关键字，后面跟类名，可以声明一个类；
  • 以enum为关键字，后面跟枚举名，可以声明一个枚举；

上面代码生成的类图如下：
在这里插入图片描述

添加类或枚举的成员

以类为例，我们可以使用:（注意前后都有一个空格）来为申明的类添加成员，名称不带()的被视为是属性，带()的被视为是方法。

@startuml
class a
a : name
a : sex
a : age
a : say_hello()
@enduml

上面的代码生成的类图如下：
在这里插入图片描述

也可以用花括号语法：

@startuml
class a{
    name
    sex
    age
    say_hello()
}
@enduml

这样的写法更接近于真实代码的形式，可以省去重复的类名和:。

申明成员类型

可以为类的成员申明数据类型。

@startuml
class a{
	String name
	bool sex
	int age
	void say_hello()
}
@enduml

可以采用C风格的前置类型声明：
在这里插入图片描述
也可以采用类似GDScript的冒号后置类型申明形式：

@startuml
class a{
	name:String 
	sex:bool
	age:int
	say_hello():void
}
@enduml

外

设定成员的可访问性

类图可以更具体的标记属性和方法的可访问性，也就是private、protected、public，如果是C++之类的或许可以用上，但是在GDScript中并不涉及这部分。
下面是具体的修饰符和意义。

字符图标(属性)图标(方法)可访问性
-private 私有
#protected 受保护
~package private 包内可见
+public 公有

下面是一个简单的例子：

@startuml
class a{
	+name:String 
	-sex:bool
	~age:int
	+say_hello():void
}
@enduml

绘制效果如下：
2

表示静态变量或方法

Godot3.x就支持静态函数，Godot4.x更是支持了静态变量。
在PlantUML类图中我们可以精确的表示静态函数和静态变量成员，以与非静态成员区分。
方法也很简单就是在静态成员之前添加{static}修饰符。

@startuml
class a{
	+ {static} name:String 
	-sex:bool
	~age:int
	+{static}say_hello():void
}
@enduml

绘制效果如下：
在这里插入图片描述

可以看到静态成员的名称下添加了下划线。

使用分隔线对成员进行自定义分组

可以在成员之间用--、..、==、__进行自定义分割线的绘制

@startuml
class a{
	ame:String 
	--
	sex:bool
	==
	age:int
	..
	say_hello():void
	__
	say_yes():void
}
@enduml

实际效果如下：
在这里插入图片描述

可以看到：

  • --是一条比较粗的横线，__是一条比较细的横线
  • ==是双横线
  • ..是虚线

你也可以在分割线基础上进行分组的命名。

@startuml
class a{
	ame:String 
	-- 性别  --
	sex:bool
	== 年龄 ==
	age:int
	.. 方法 ..
	say_hello():void
	__ 还是方法 __
	say_yes():void
}
@enduml

绘制效果如下：
在这里插入图片描述

这样我们可以将成员进行分组，让类的结构更清晰易懂。

多个类之间的关系表示

关系类型符号绘图
泛化关系<|–
组合关系*–
聚合关系o–
  • --代表实线，可以用..替代表示虚线。
  • <|、*和o分别代表箭头的类型

类与类之间的关系可以查阅相关的视频或文档，这里不做赘述，这里只举例说明继承关系的表示。

@startuml
Car <|-- Bus
@enduml

这里我们直接省略class关键字，申明了Car和Bus两个类，并且使用<|--连接它们。
生成的类图如下：
在这里插入图片描述

它的含义就是，Car作为父类，Bus作为子类，Bus继承自Car。

  • 新手注意：继承关系的箭头是由子类指向父类。

我们可以继续这个例子，添加Car的其他子类型：

@startuml
Car <|-- Bus
Car <|-- motorcycle
Car <|-- bicycle
@enduml

生成类图如下：
在这里插入图片描述

在箭头连线上添加文本

可以在整个箭头连线关系的最后，在:后面添加文本信息，用于显示在连线上。

@startuml
Car <|-- Bus:继承自
Car <|-- motorcycle:继承自
Car <|-- bicycle:继承自
@enduml

生成类图如下：
在这里插入图片描述

表示类之间的数量关系

也可以用双引号，在连线的起始端和末尾端添加文本，用于表示类似ER（实体关系图）中的“一对一”、“一对多”、“多对多”等关系。
在继承关系中可能使用这种描述不太恰当，可以在“组合”或“聚合”等关系中使用。
下面的代码表示，一个汽车有4个轮子组成：

@startuml
汽车 "1" *-- "4" 轮子:组成
@enduml

生成类图如下：
在这里插入图片描述

控制类绘制的位置

在连线之间可以使用up、down、left和right关键字来手动控制类的绘制位置。
以之前的Car派生的例子为例：

@startuml
Car <|-- Bus:继承自
Car <|-- motorcycle:继承自
Car <|-- bicycle:继承自
@enduml

默认绘制为：
在这里插入图片描述

通过在表示实线的--之间，指定上下左右方位的关键字：

@startuml
Car <|-left- Bus:继承自
Car <|-up- motorcycle:继承自
Car <|-right- bicycle:继承自
@enduml

就可以将类图渲染为如下形式：
在这里插入图片描述

绘制备注

note关键字用于绘制备注。
可以使用note 位置 of 元素的形式，为类、枚举或者其他类图元素设定备注。

@startuml
Car <|-left- Bus:继承自
Car <|-up- motorcycle:继承自
Car <|-right- bicycle:继承自

note bottom of Car:车，基类
note bottom of Bus:公共汽车
note bottom of bicycle:自行车
note left of motorcycle:摩托车
@enduml

绘制效果如下：
在这里插入图片描述

还有一种写法，可以省略of 元素，但是需要紧跟在class申明之后，或者指定两个类的关系之后。

@startuml
class Car
note bottom:车，基类

Car <|-left- Bus:继承自
note bottom:公共汽车

Car <|-up- motorcycle:继承自
note left:摩托车

Car <|-right- bicycle:继承自
note bottom:自行车
@enduml

绘制效果如下：
在这里插入图片描述

可以看到效果基本上无异。
还可以用note "备注内容" as 变量形式将备注申明为一个类似单独元素的东西。
再使用--或..进行连接：

@startuml
class Car
note "车，基类" as N1
Car -- N1
@enduml

效果如下：
在这里插入图片描述

另外，在备注中，可以使用\n进行多行文本的换行控制。

为类图添加标题

使用title关键字可以为类图添加标题。

@startuml
title 车类的继承关系类图
Car <|-left- Bus:继承自
Car <|-up- motorcycle:继承自
Car <|-right- bicycle:继承自

note bottom of Car:车，基类
note bottom of Bus:公共汽车
note bottom of bicycle:自行车
note left of motorcycle:摩托车
@enduml

绘制效果如下：
在这里插入图片描述

为类图添加页脚

如果你不喜欢顶部的标题，可以使用footer关键字指定一个底部的页脚。

@startuml

Car <|-left- Bus:继承自
Car <|-up- motorcycle:继承自
Car <|-right- bicycle:继承自

note bottom of Car:车，基类
note bottom of Bus:公共汽车
note bottom of bicycle:自行车
note left of motorcycle:摩托车
footer 车类的继承关系类图
@enduml

绘制效果如下：
在这里插入图片描述

Godot中的一些类图实例

上面我们已经学习了如何用PlantUML进行类图的绘制。下面就举一些Godot中的例子。

子类与父类（继承关系）

@startuml

Control <|-- Button
note bottom:泛化关系（继承关系）\n子类指向父类，\n实线空心三角箭头

@enduml

绘图效果：
在这里插入图片描述

成员引用（一般关联关系）

@startuml

class class01{
	attr:class02
}

class01 --> class02
note bottom:单向关联关系\n引用者指向被引用者

class class03{
	attr:class04
}

class class04{
	attr:class03
}

class03 -- class04
note bottom:双向关联关系\n箭头消失

class class05{
	sub_itm:class05
}

class05 --> class05
note bottom:自关联关系\n自己的成员变量引用自己

@enduml

绘制效果：
在这里插入图片描述

部分与整体（聚合与组合）

@startuml

class Player {
}
note left:玩家
Player -up-|> CharacterBody2D
Player o-- CollisionShape2D
note bottom:碰撞形状
Player o-- Sprite
note bottom:玩家长相
@enduml

绘制效果：
在这里插入图片描述

更复杂的可以有：

@startuml
title Godot中2D角色的节点组成结构（2）
class Player {
}
note left:玩家
Player -up-|> CharacterBody2D
Player o-- CollisionShape2D
note bottom:碰撞形状
Shape2D <-down- CollisionShape2D
Player o-- HitBox
note bottom:攻击判定区域
HitBox -up-|> Area2D
CollisionShape2D2 -down-o HitBox
Shape2D <-down- CollisionShape2D2

Player o-- Sprite
note bottom:玩家长相
@enduml

在这里插入图片描述

组合关系

@startuml
title Godot中的组合关系
class Tree {
}

Tree *-- TreeItem
note right:组合关系，\n父类由子类组成，\n父类消失，子类失去意义，\n子类消失，父类无法构成。

@enduml

在这里插入图片描述

依赖关系

@startuml
title Godot中类的依赖关系
class ShapePoints {
+static rect():PackedVector2Array
}

class myCanvas{
+ draw_rect():void
}


ShapePoints <.. myCanvas
note right: 依赖关系：\n一个类用**局部变量**、\n**方法参数**或者\n**对静态方法的调用**\n来访问另一个类

@enduml

在这里插入图片描述

总结

本文带领Godot使用者，学习和使用基础的PlantUML类图绘制技巧。
希望对Godoter们编写和设计自己的类以及类库有所帮助，你也可以用来绘制和讲解设计模式等。
本文不详之处，可以查阅其他大佬的文章或翻找PlantUML官方文档。
若有错误之处，还请指正。

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/1895144.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

2024 年第十四届 APMCM 亚太地区大学生数学建模竞赛B题超详细解题思路+数据预处理问题一代码分享

2024 年第十四届 APMCM 亚太地区大学生数学建模竞赛B题超详细解题思路+数据预处理问题一代码分享

B题 洪水灾害的数据分析与预测 亚太中文赛事本次报名队伍约3000队&#xff0c;竞赛规模体量大致相当于2024年认证杯&#xff0c;1/3个妈杯&#xff0c;1/10个国赛。赛题难度大致相当于0.6个国赛&#xff0c;0.8个妈杯。该比例仅供大家参考。 本次竞赛赛题难度A:B:C3:1:4&…
阅读更多...
学习笔记——动态路由——OSPF（OSPF状态机、DR\BDR选举）

学习笔记——动态路由——OSPF（OSPF状态机、DR\BDR选举）

七、OSPF状态机、DR\BDR选举 1、OSPF的8种状态机 OSPF在邻居与邻接建立的过程中会经过多个状态机的变化&#xff0c;状态机的出现不仅能让我们了解OSPF建立过程&#xff0c;也能在OSPF出现故障的时候通过状态机的状态来粗略判断问题的所在。 (1)邻居建立状态变化过程 1、Dow…
阅读更多...
搜维尔科技：Xsens实时动作捕捉，驱动人形机器人操作！

搜维尔科技：Xsens实时动作捕捉，驱动人形机器人操作！

搜维尔科技&#xff1a;http://www.souvr.comhttp://www.souvr.com实时动作捕捉&#xff0c;驱动人形机器人操作&#xff01; 搜维尔科技&#xff1a;Xsens实时动作捕捉&#xff0c;驱动人形机器人操作&#xff01;
阅读更多...
Vue3Echarts写关于温湿度统计的好看折线图

Vue3Echarts写关于温湿度统计的好看折线图

在项目统计界面&#xff0c;我们离不开对Echarts的使用&#xff0c;接下来是我在做项目过程中做的一个关于温湿度统计的好看折线图&#xff0c;统计的是温度蓝色和湿度绿色&#xff0c;它们还会有告警和断电&#xff0c;分别用橘黄色和红色区分&#xff0c;以下是示例&#xff…
阅读更多...
anaconda命令大全

anaconda命令大全

目录 查看所有虚拟环境查看某虚拟环境安装的包创建虚拟环境激活创建好的虚拟环境回到之前的环境删除创建的虚拟环境查看conda所在的位置、虚拟环境位置等信息conda修改虚拟环境所在的位置 查看所有虚拟环境 conda env list查看某虚拟环境安装的包 激活要查看的虚拟环境之后&a…
阅读更多...
欢乐钓鱼大师游戏攻略：在什么地方掉称号鱼？云手机游戏辅助！

欢乐钓鱼大师游戏攻略：在什么地方掉称号鱼？云手机游戏辅助！

《欢乐钓鱼大师》是一款融合了休闲娱乐和策略挑战的钓鱼游戏。游戏中的各种鱼类不仅各具特色&#xff0c;而且钓鱼过程充满了挑战和乐趣。下面将为大家详细介绍如何在游戏中钓鱼&#xff0c;以及一些有效的钓鱼技巧&#xff0c;帮助你成为一个出色的钓鱼大师。 实用工具推荐 为…
阅读更多...
如何计算弧线弹道的落地位置

如何计算弧线弹道的落地位置

1&#xff09;如何计算弧线弹道的落地位置 2&#xff09;Unity 2021 IL2CPP下使用Protobuf-net序列化报异常 3&#xff09;编译问题&#xff0c;用Mono可以&#xff0c;但用IL2CPP就报错 4&#xff09;Wwise的Bank在安卓上LoadBank之后&#xff0c;播放没有声音 这是第393篇UWA…
阅读更多...
oracle存储结构-----逻辑存储结构（表空间、段、区、块）

oracle存储结构-----逻辑存储结构（表空间、段、区、块）

文章目录 oracle存储结构图&#xff08;逻辑存储物理存储&#xff09;oracle逻辑存储结构图逻辑存储结构、表空间、段、区、数据块的关系&#xff1a;1、数据 块&#xff08;block&#xff09;---逻辑存储最小单位2、 数据区&#xff08;extent&#xff09;--存储空间分配和回收…
阅读更多...
使用 Git Hooks 防止敏感信息泄露

使用 Git Hooks 防止敏感信息泄露

欢迎关注公众号&#xff1a;冬瓜白 在日常开发中&#xff0c;我们可能会不小心将敏感信息提交到 Git。为了防止这种情况&#xff0c;可以利用 Git Hooks 编写一个简单的脚本&#xff0c;当发现提交中包含敏感词时&#xff0c;给出提示。 以下是一个基于 pre-commit 钩子的示例…
阅读更多...
记录在Linux（龙蜥8.6）配置jdk环境变量不生效问题

记录在Linux（龙蜥8.6）配置jdk环境变量不生效问题

在Linux中&#xff0c;将jdk解压至 /opt/soft/jdk 目录中&#xff0c;使用root用户配置在/etc/profile中配置环境变量并source后&#xff0c;使用root用户是正常的&#xff0c;但是切换到普通用户后提示&#xff1a; 这个问题是普通用户对 /opt/soft/jdk 目录无执行权限 解决&…
阅读更多...
面向对象-封装

面向对象-封装

一.包 1.简介 当我们把所有的java类都写src下的第一层级&#xff0c;如果是项目中&#xff0c;也许会有几百个java文件。 src下的文件会很多&#xff0c;开发的时候不方便查找&#xff0c;也不方便维护如果较多的文件中有同名的&#xff0c;十分麻烦 模块1中有一个叫test.ja…
阅读更多...
汇聚荣拼多多评价好不好？

汇聚荣拼多多评价好不好？

汇聚荣拼多多评价好不好?在探讨电商平台的口碑时&#xff0c;用户评价是衡量其服务质量和商品质量的重要指标。拼多多作为国内领先的电商平台之一&#xff0c;其用户评价自然成为消费者选择购物平台时的参考依据。针对“汇聚荣拼多多评价好不好?”这一问题&#xff0c;可以从…
阅读更多...
Pinia：Vue 2 和 Vue 3 中更好用的状态管理框架

Pinia：Vue 2 和 Vue 3 中更好用的状态管理框架

前言 还在用Vuex? 在Vue应用程序的开发过程中&#xff0c;高效且易于维护的状态管理一直是开发者关注的核心问题之一。随着Vue 3的发布&#xff0c;状态管理领域迎来了一位新星——Pinia&#xff0c;它不仅为Vue 3量身打造&#xff0c;同时也向下兼容Vue 2&#xff0c;以其简…
阅读更多...
uni-appx，实现登录功能，弹窗功能。组件之间传值

uni-appx，实现登录功能，弹窗功能。组件之间传值

这篇文章的内容使用组合式API实现的&#xff0c;只有弹窗部分有选择式API的写法介绍。如果想要看其他选择式API&#xff0c;还请下载官方的hello-uni-appx源码进行学习&#xff0c;查看。想要看组合式API的写法&#xff0c;请查看源码 hello-uvue。 hello-uni-appx源码 相比于…
阅读更多...
JavaSE （Java基础）：面向对象（下）

JavaSE （Java基础）：面向对象（下）

8.7 多态 什么是多态&#xff1f; 即同一方法可以根据发送对象的不同而采用多种不同的方式。 一个对象的实际类型是确定的&#xff0c;但可以指向对象的引用的类型有很多。在句话我是这样理解的&#xff1a; 在实例中使用方法都是根据他最开始将类实例化最左边的类型来定的&…
阅读更多...
http数据传输确保完整性和保密性整流程方案(含源码)

http数据传输确保完整性和保密性整流程方案(含源码)

往期文章回顾 【深度学习】 【深度学习】物体检测/分割/追踪/姿态估计/图像分类检测演示系统【含源码】【深度学习】YOLOV8数据标注及模型训练方法整体流程介绍及演示【深度学习】行人跌倒行为检测软件系统【深度学习】火灾检测软件系统【深度学习】吸烟行为检测软件系统【深度…
阅读更多...
element-ui el-select选择器组件下拉框增加自定义按钮

element-ui el-select选择器组件下拉框增加自定义按钮

element-ui el-select选择器组件下拉框增加自定义按钮 先看效果 原理&#xff1a;在el-select下添加禁用的el-option&#xff0c;将其value绑定为undefined&#xff0c;然后覆盖el-option禁用状态下的默认样式即可 示例代码如下&#xff1a; <template><div class…
阅读更多...
Maxwell 数据采集工具详解

Maxwell 数据采集工具详解

欢迎来到我的博客&#xff0c;很高兴能够在这里和您见面&#xff01;欢迎订阅相关专栏&#xff1a; 欢迎关注微信公众号&#xff1a;野老杂谈 ⭐️ 全网最全IT互联网公司面试宝典&#xff1a;收集整理全网各大IT互联网公司技术、项目、HR面试真题. ⭐️ AIGC时代的创新与未来&a…
阅读更多...
修改头文件版本需要修改的文件

修改头文件版本需要修改的文件

以修改ui的头文件版本为例&#xff0c;还需要同时更新 PJ10PC20240120041_c928\components\master-t5\hikauto\module\app\include PJ10PC20240120041_c928\components\master-t5\hikauto\module\app\include\dsp PJ10PC20240120041_c928\components\master-t5\hikauto\incl…
阅读更多...
文华财经T8多空量化交易策略模型源码

文华财经T8多空量化交易策略模型源码

//定义变量 N : 3; // 连续K线数量&#xff08;可根据需要调整&#xff09; Q : 0.05; // 止盈比例5%&#xff08;可根据需要调整&#xff09; HIGH_PRICE : REF(HIGH, 1); // 记录前根阳线的最高价 LOW_PRICE : REF(LOW, 1); // 记录前根阴线的最低价 //做多策略 REF(EV…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023