技术标签: gdscript Godot4.0 代码注释 代码可读性 godot
我个人于2020年9月左右开始接触Godot,在2021年8月汉化一个关于GDScript脚本注释习惯的视频时,学习到了一些有用的代码注释规则,于是逐渐将一些注释习惯引入自己的代码书写中。这些注释习惯一直延续至今,并逐渐形成我自己的一种风格。
本篇就来介绍一下我自己的注释习惯,以及谈谈这样做的好处。当然你并不需要完全和我一致,每个人都有自己的书写习惯和内心所尊崇的规范。
无论你是为一个简单的场景,创建十几二十行代码,还是为静态函数库、自定义类等创建成百甚至上千行代码。良好并且恰到好处的注释可能会让你的代码更具可读性。
我们直接以一个例子开始。创建如下场景:
根节点添加如下代码:
extends Control
var u_name = "Godotter"
@onready var button = $Button
@onready var label = $Label
@export var text_color:Color = Color.RED
func _on_button_pressed():
label.text = "你好!%s" % u_name
pass
func set_text_color(label:Label,color:Color):
var lab_set:LabelSettings
if not label.label_settings:
label.label_settings = LabelSettings.new()
lab_set = label.label_settings
lab_set.font_color = color
func _ready():
button.text = "点我"
set_text_color(label,text_color)
pass
原谅我这里为了演示,比较极端,没有写任何注释。主要是为了加强没有注释与有良好注释的代码可读性对比。
可以看到这段代码几乎集齐了GDScript脚本最常见的元素:
_ready()
_on_button_pressed()
为连接Button
的pressed
信号后Godot自动生成的信号处理函数。set_text_color
@onready var
u_name
text_color
添加了我自己风格注释后的代码:
# ========================================================
# 名称:comments_test
# 类型:普通测试场景脚本
# 简介:展示基础的注释风格
# 作者:巽星石
# Godot版本:v4.2.1.stable.official [b09f793f5]
# 创建时间:2024年3月23日15:00:13
# 最后修改时间:2024年3月23日15:28:16
# ========================================================
extends Control
# =================================== 属性 ===================================
var u_name = "Godotter" # 用户名
# =================================== 面板参数 ===================================
@export var text_color:Color = Color.RED # label的文本颜色
# =================================== 节点引用 ===================================
@onready var button = $Button
@onready var label = $Label
# =================================== 虚函数 ===================================
func _ready():
button.text = "点我" # 初始化按钮文本
set_text_color(label,text_color) # 设置label的字体颜色
# =================================== 信号处理函数 ===================================
# 按钮按下
func _on_button_pressed():
label.text = "你好!%s" % u_name # 显示问候语
# =================================== 自定义函数 ================================
# 设定label的文字颜色为color
func set_text_color(label:Label,color:Color):
if not label.label_settings: # 没有设定label_settings
label.label_settings = LabelSettings.new() # 创建新的LabelSettings并赋值
# 设定颜色
var lab_set = label.label_settings
lab_set.font_color = color
可以看到:
对于分割线注释,就是利用大量重复的字符,构成视觉上的线状结构,用于将代码进行视觉上的分区。并通过命名,描述分区的含义。
除了像上面将脚本划分为大的区域外,在每个区域中又可以进行小区域的划分。主要就是通过视觉上更细或更短的分割线注释来展现一种视觉上的层级或主次关系,至于具体用什么样的字符可以自己尝试。
=
号分割线的细一号可以尝试用-
号最常见的就是对自定义函数进行更细致的分组:
# =================================== 自定义函数 ===================================
# ========= 节点相关
# ------------------------ 节点创建 ------------------------
# 创建指定类型的2D节点实例
func create_Node2D(type:String) -> Node2D:
...
pass
# 创建指定类型的控件实例
func create_Control(type:String) -> Control:
...
pass
# ------------------------ 节点路径 ------------------------
# 获取指定节点的节点路径
func get_node_path(node:Node) -> NodePath:
...
pass
# 两个数组
var arr1 = []
var arr2 = []
通过;
合并为一行:
var arr1 = [];var arr2 = [] # 两个数组
可以看到,3行代码,变成1行,这是一种很常见的代码紧缩化处理。可以有效减少代码的行数。
减少代码行数的另一个常见方法是将简单的if...else...
语句改写为三元运算符形式,比如:
# 为c赋值a和b中较大的一个
if a>b:
c = a
else:
c = b
像上面这样最简单的判断和赋值,占据4行,简直是“罪过”,我们可以将其修改为:
c = a if a>b else b # 为c赋值a和b中较大的一个
在代码的局部,可以通过对齐多行的行内注释,增加视觉美感和可读性。
这里以多个导出变量为例:
@export var text:String = "" # 文本
@export var tool_tip:String = "" # 鼠标提示文本
@export var font_color:Color = Color.RED # 文本颜色
@export var bg_color:Color = Color.RED # 背景颜色
每行末尾的注释,各自为战,参差不齐。对齐后:
@export var text:String = "" # 文本
@export var tool_tip:String = "" # 鼠标提示文本
@export var font_color:Color = Color.RED # 文本颜色
@export var bg_color:Color = Color.RED # 背景颜色
可以看到明显降低了视觉上的杂乱度,注释整齐划一,阅读心情也变得很轻松。
下面是我的一个自定义函数库ShapePoints
中一个求圆角矩形顶点的函数,可以看到它有很长的参数列表,这在代码编辑器中,很可能需要滚动水平滚动条才能看清楚整个的函数定义。
# 求圆角矩形的顶点
static func round_rect(size:Vector2,r1:float,r2:float,r3:float,r4:float,offset:Vector2 = Vector2.ZERO) -> PackedVector2Array:
...
return points
通过将参数换行和缩进对齐,并为其添加对齐的行内注释,可读性瞬间上升:
# 求圆角矩形的顶点
static func round_rect(
size:Vector2, # 矩形的尺寸
r1:float,r2:float,r3:float, r4:float, # 4个角圆角半径
offset:Vector2 = Vector2.ZERO # 矩形位置(左上角)的偏移
) -> PackedVector2Array:
...
return points
以申明两个数组为例:
# 两个数组
var arr1 = []
var arr2 = []
上面的声明没有明确限定变量的类型,如果不是= []
的赋初始值操作,引擎根本不知道你申明变量的类型,对于阅读代码的人来说也是一种困惑。
所以好的申明习惯是:始终显示申明变量的类型。
# 两个数组
var arr1:Array[PackedScene] = []
var arr2:PackedStringArray = []
好处有三:
func _ready():
pass
func sum(a:int,b:int):
return a + b
func show_msg(msg:String):
print(msg)
通过->
符号,我们可以明确指定函数的返回值类型:
func _ready() -> void:
pass
func sum(a:int,b:int) -> int:
return a + b
func show_msg(msg:String) -> void:
print(msg)
好处是:
对于提高代码可读性,可能还有诸如使用有意义的变量名,以及规范变量或函数命名规则等。这里就不再赘述。
如果你觉得还有哪些好的提高代码可读性的好方法,可以留言或讨论。希望本篇内容对学习Godot的小伙伴们有用。
文章浏览阅读2.5w次,点赞6次,收藏50次。官方解释是,docker 容器是机器上的沙盒进程,它与主机上的所有其他进程隔离。所以容器只是操作系统中被隔离开来的一个进程,所谓的容器化,其实也只是对操作系统进行欺骗的一种语法糖。_docker菜鸟教程
文章浏览阅读5.7k次,点赞3次,收藏14次。该如何避免的,今天小编给大家推荐两个下载Windows系统官方软件的资源网站,可以杜绝软件捆绑等行为。该站提供了丰富的Windows官方技术资源,比较重要的有MSDN技术资源文档库、官方工具和资源、应用程序、开发人员工具(Visual Studio 、SQLServer等等)、系统镜像、设计人员工具等。总的来说,这两个都是非常优秀的Windows系统镜像资源站,提供了丰富的Windows系统镜像资源,并且保证了资源的纯净和安全性,有需要的朋友可以去了解一下。这个非常实用的资源网站的创建者是国内的一个网友。_msdn我告诉你
文章浏览阅读1.2k次。vue2封装对话框el-dialog组件_
文章浏览阅读4.7k次,点赞5次,收藏6次。MFC 文本框换行 标签: it mfc 文本框1.将Multiline属性设置为True2.换行是使用"\r\n" (宽字符串为L"\r\n")3.如果需要编辑并且按Enter键换行,还要将 Want Return 设置为 True4.如果需要垂直滚动条的话将Vertical Scroll属性设置为True,需要水平滚动条的话将Horizontal Scroll属性设_c++ mfc同一框内输入二行怎么换行
文章浏览阅读832次。检查Linux是否是否开启所需端口,默认为6379,若未打开,将其开启:以root用户执行iptables -I INPUT -p tcp --dport 6379 -j ACCEPT如果还是未能解决,修改redis.conf,修改主机地址:bind 192.168.85.**;然后使用该配置文件,重新启动Redis服务./redis-server redis.conf..._redis-server doesn't support auth command or ismisconfigured. try
文章浏览阅读4.9k次。济大数电实验报告_数据选择器及其应用
文章浏览阅读236次。1研究内容消费在生产中占据十分重要的地位,是生产的最终目的和动力,是保持省内经济稳定快速发展的核心要素。预测河南省社会消费品零售总额,是进行宏观经济调控和消费体制改变创新的基础,是河南省内人民对美好的全面和谐社会的追求的要求,保持河南省经济稳定和可持续发展具有重要意义。本文建立灰色预测模型,利用MATLAB软件,预测出2019年~2023年河南省社会消费品零售总额预测值分别为21881...._灰色预测模型用什么软件
文章浏览阅读1.2k次。12.4-在Qt中使用Log4Qt输出Log文件,看这一篇就足够了一、为啥要使用第三方Log库,而不用平台自带的Log库二、Log4j系列库的功能介绍与基本概念三、Log4Qt库的基本介绍四、将Log4qt组装成为一个单独模块五、使用配置文件的方式配置Log4Qt六、使用代码的方式配置Log4Qt七、在Qt工程中引入Log4Qt库模块的方法八、获取示例中的源代码一、为啥要使用第三方Log库,而不用平台自带的Log库首先要说明的是,在平时开发和调试中开发平台自带的“打印输出”已经足够了。但_log4qt
文章浏览阅读786次。全局观思维模型,一个教我们由点到线,由线到面,再由面到体,不断的放大格局去思考问题的思维模型。_计算机中对于全局观的
文章浏览阅读330次。一、CountDownLatch介绍CountDownLatch采用减法计算;是一个同步辅助工具类和CyclicBarrier类功能类似,允许一个或多个线程等待,直到在其他线程中执行的一组操作完成。二、CountDownLatch俩种应用场景: 场景一:所有线程在等待开始信号(startSignal.await()),主流程发出开始信号通知,既执行startSignal.countDown()方法后;所有线程才开始执行;每个线程执行完发出做完信号,既执行do..._countdownluach于cyclicbarrier的用法
文章浏览阅读508次。Prometheus 算是一个全能型选手,原生支持容器监控,当然监控传统应用也不是吃干饭的,所以就是容器和非容器他都支持,所有的监控系统都具备这个流程,_-自动化监控系统prometheus&grafana实战
文章浏览阅读4.7k次。输入关键字,可以通过键盘的搜索按钮完成搜索功能。_react search