技术标签: 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的小伙伴们有用。
文章浏览阅读451次。dev/mem: 物理内存的全镜像。可以用来访问物理内存。/dev/kmem: kernel看到的虚拟内存的全镜像。可以用来访问kernel的内容。调试嵌入式Linux内核时,可能需要查看某个内核变量的值。/dev/kmem正好提供了访问内核虚拟内存的途径。现在的内核大都默认禁用了/dev/kmem,打开的方法是在 make menuconfig中选中 device drivers --> ..._dev/mem 源码实现
文章浏览阅读7.1k次,点赞2次,收藏19次。vxe-table,一个小众但功能齐全并支持excel操作的vue表格组件_vxe-table
文章浏览阅读62次。参考:http://www.ruanyifeng.com/blog/2016/01/babel.htmlBabelBabel是一个广泛使用的转码器,可以将ES6代码转为ES5代码,从而在现有环境执行// 转码前input.map(item => item + 1);// 转码后input.map(function (item) { return item..._让开发环境支持bable
文章浏览阅读2.8k次,点赞6次,收藏29次。摘要:FPGA视频处理FIFO的典型应用,视频输入FIFO的作用,视频输出FIFO的作用,视频数据跨时钟域FIFO,视频缩放FIFO的作用_fpga 频分复用 视频
文章浏览阅读575次。【代码】R语言:设置工作路径为当前文件存储路径。_r语言设置工作目录到目标文件夹
文章浏览阅读452次。格式:background: linear-gradient(direction, color-stop1, color-stop2, ...);<linear-gradient> = linear-gradient([ [ <angle> | to <side-or-corner>] ,]? &l..._background线性渐变
文章浏览阅读1k次,点赞26次,收藏8次。第十三届蓝桥杯青少年组python编程省赛真题一、题目要求(注:input()输入函数的括号中不允许添加任何信息)1、编程实现给定一个正整数N,输出正整数N中各数位最大的那个数字。例如:N=132,则输出3。2、输入输出输入描述:只有一行,输入一个正整数N输出描述:只有一行,输出正整数N中各数位最大的那个数字输入样例:
文章浏览阅读2.2k次。一个网络协议主要由以下三个要素组成:1.语法数据与控制信息的结构或格式,包括数据的组织方式、编码方式、信号电平的表示方式等。2.语义即需要发出何种控制信息,完成何种动作,以及做出何种应答,以实现数据交换的协调和差错处理。3.时序即事件实现顺序的详细说明,以实现速率匹配和排序。不完整理解:语法表示长什么样,语义表示能干什么,时序表示排序。转载于:https://blog.51cto.com/98..._网络协议三要素csdn
文章浏览阅读153次。主要的思想,将所有的系统都可以看作两部分,真正的数据log系统和各种各样的query engine所有的一致性由log系统来保证,其他各种query engine不需要考虑一致性,安全性,只需要不停的从log系统来同步数据,如果数据丢失或crash可以从log系统replay来恢复可以看出kafka系统在linkedin中的重要地位,不光是d..._the log: what every software engineer should know about real-time data's uni
文章浏览阅读746次。伟大是熬出来的 目录 前言 引言 时间熬成伟大:领导者要像狼一样坚忍 第一章 内圣外王——领导者的心态修炼 1. 天纵英才的自信心 2. 上天揽月的企图心 3. 誓不回头的决心 4. 宠辱不惊的平常心 5. 换位思考的同理心 6. 激情四射的热心 第二章 日清日高——领导者的高效能修炼 7. 积极主动,想到做到 8. 合理掌控自己的时间和生命 9. 制定目标,马..._当狼拖着受伤的右腿逃生时,右腿会成为前进的阻碍,它会毫不犹豫撕咬断自己的腿, 以
文章浏览阅读285次。在当今的大数据时代,人们对高速度和高带宽的需求越来越大,迫切希望有一种新型产品来作为高性能计算和数据中心的主要传输媒质,所以有源光缆(AOC)在这种环境下诞生了。有源光缆究竟是什么呢?应用在哪些领域,有什么优势呢?易天将为您解答!有源光缆(Active Optical Cables,简称AOC)是两端装有光收发器件的光纤线缆,主要构成部件分为光路和电路两部分。作为一种高性能计..._aoc 光缆
文章浏览阅读2.2k次。在“桌面”上按快捷键“Ctrl+R”,调出“运行”窗口。接着,在“打开”后的输入框中输入“Gpedit.msc”。并按“确定”按钮。如下图 找到“用户配置”下的“Windows设置”下的“Internet Explorer 维护”的“连接”,双击选择“自动浏览器配置”。如下图 选择“自动启动配置”,并在下面的“自动代理URL”中填写相应的PAC文件地址。如下..._設置proxy腳本