技术标签: 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.9k次,点赞8次,收藏14次。测试主要做什么?这完全都体现在测试流程中,同时测试流程是面试问题中出现频率最高的,这不仅是因为测试流程很重要,而是在面试过程中这短短的半小时到一个小时的时间,通过测试流程就可以判断出应聘者是否合适,故在测试流程中包含了测试工作的核心内容,例如需求分析,测试用例的设计,测试执行,缺陷等重要的过程。..._测试过程管理中包含哪些过程
文章浏览阅读870次,点赞16次,收藏19次。1.背景介绍政府数字化政务是指政府利用数字技术、互联网、大数据、人工智能等新技术手段,对政府政务进行数字化改革,提高政府工作效率,提升政府服务质量的过程。随着人工智能(AI)和机器学习(ML)技术的快速发展,政府数字化政务中的人工智能与机器学习应用也逐渐成为政府改革的重要内容。政府数字化政务的人工智能与机器学习应用涉及多个领域,包括政策决策、政府服务、公共安全、社会治理等。在这些领域,人工...
文章浏览阅读219次,点赞2次,收藏4次。系统主要的用户为用户、管理员,他们的具体权限如下:用户:用户登录后可以对管理员上传的学习视频进行学习。用户可以选择题型进行练习。用户选择小程序提供的考研科目进行相关训练。用户可以进行水平测试,并且查看相关成绩用户可以进行错题集的整理管理员:管理员登录后可管理个人基本信息管理员登录后可管理个人基本信息管理员可以上传、发布考研的相关例题及其分析,并对题型进行管理管理员可以进行查看、搜索考研题目及错题情况。_mysql刷题软件
文章浏览阅读1.4k次。myelipse里有UML1和UML2两种方式,UML2功能更强大,但是两者生成过程差别不大1.建立Test工程,如下图,uml包存放uml类图package com.zz.domain;public class User {private int id;private String name;public int getId() {return id;}public void setId(int..._根据以下java代码画出类图
文章浏览阅读174次。需求:一个topic包含很多个表信息,需要自动根据json字符串中的字段来写入到hive不同的表对应的路径中。发送到Kafka中的数据原本最外层原本没有pkDay和project,只有data和name。因为担心data里面会空值,所以根同事商量,让他们在最外层添加了project和pkDay字段。pkDay字段用于表的自动分区,proejct和name合起来用于自动拼接hive表的名称为 ..._flume拦截器自定义开发 kafka
文章浏览阅读380次。原标题:Java Spring中同时访问多种不同数据库 多样的工作要求,可以使用不同的工作方法,只要能获得结果,就不会徒劳。开发企业应用时我们常常遇到要同时访问多种不同数据库的问题,有时是必须把数据归档到某种数据仓库中,有时是要把数据变更推送到第三方数据库中。使用Spring框架时,使用单一数据库是非常容易的,但如果要同时访问多个数据库的话事件就变得复杂多了。本文以在Spring框架下开发一个Sp..._根据输入的不同连接不同的数据库
文章浏览阅读3.6k次,点赞9次,收藏25次。本案例描述了晶振屏蔽以及开关电源变压器屏蔽对系统稳定工作的影响, 硬件设计时应考虑。_eft电路图
文章浏览阅读1.1k次。对于物料价格的更改,可以采取不同的手段:首先,我们来介绍MR21的方式。 需要说明的是,如果要对某一产品进行价格修改,必须满足的前提条件是: ■ 1、必须对价格生效的物料期间与对应会计期间进行开启; ■ 2、该产品在该物料期间未发生物料移动。执行MR21,例如更改物料1180051689的价格为20000元,系统提示“对于物料1180051689 存在一个当前或未来标准价格”,这是因为已经对该..._mr21 对于物料 zba89121 存在一个当前或未来标准价格
文章浏览阅读7.4k次,点赞3次,收藏13次。[文章导读]联想启天M420是一款商用台式电脑,预装的是win10系统,用户还是喜欢win7系统,该台式机采用的intel 8代i5 8500CPU,在安装安装win7时有很多问题,在安装win7时要在BIOS中“关闭安全启动”和“开启兼容模式”,并且安装过程中usb不能使用,要采用联想win7新机型安装,且默认采用的uefi+gpt模式,要改成legacy+mbr引导,那么联想启天M420台式电..._启天m420刷bios
文章浏览阅读2.7k次,点赞2次,收藏9次。一,为什么要冗余数据互联网数据量很大的业务场景,往往数据库需要进行水平切分来降低单库数据量。水平切分会有一个patition key,通过patition key的查询能..._保证冗余性
文章浏览阅读88次。是时候闭环Java应用了 原创 2016-08-16 张开涛 你曾经因为部署/上线而痛苦吗?你曾经因为要去运维那改配置而烦恼吗?在我接触过的一些部署/上线方式中,曾碰到过以下一些问题:1、程序代码和依赖都是人工上传到服务器,不是通过工具进行部署和发布;2、目录结构没有规范,jar启动时通过-classpath任意指定;3、fat jar,把程序代码、配置文件和依赖jar都打包到一个jar中,改配置..._那么需要把上面的defaultjavatyperesolver类打包到插件中
文章浏览阅读909次。1.得下载一个番茄插件,按alt+g才可以有函数跳转功能。2.不安装番茄插件,按F12也可以有跳转功能。3.进公司的VS工程是D:\sync\build\win路径,.sln才是打开工程的方式,一个是VS2005打开的,一个是VS2013打开的。4.公司库里的线程接口,在CmThreadManager.h 里,这个里面是我们的线程库,可以直接拿来用。CreateUserTaskThre..._番茄助手颜色