技术标签: 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的小伙伴们有用。
文章浏览阅读3k次,点赞51次,收藏41次。熟悉这些机器人的常见格式,对于创建和操作机器人是至关重要的_sdf和urdf
文章浏览阅读745次。一、软件工程中的设计数据设计或类设计将类模型转化为设计类的实现以及软件实现所要求的数据结构。体系结构设计定义了软件的主要结构化元素之间的关系、可满足系统需求的体系结构风格和模式以及影响体系结构实现方式的约束。接口设计描述了软件和协作系统之间、软件和使用人员之间如何通信。构件级设计将软件体系结构的结构化元素变换为对软件的过程性描述。二、软件质量指导原则和属性软件质量指导原则..._设计概念功能独立
文章浏览阅读6.8k次,点赞10次,收藏65次。文章目录一、打开软件1.1 打开kettle1.2 打开SQL Server1.3 打开navicat1.3.1 navicat连接sqlserver准备sql server数据表(dept)准备sql server数据表(emp)1.3.2 navicat连接mysql1.4 可能出现的bug问题Error connecting to database: (using class org.gjt.mm.mysql.Driver)Error connecting to database: (using c._kettle任务调度
文章浏览阅读1.4w次,点赞5次,收藏19次。http://www.gad.qq.com/article/detail/32503以代码托管平台起家的 GitHub 网站,已然成为全球程序员工作和生活中不可或缺的一份子。从优秀的企业,到优秀的程序员,都将自己最优秀的代码作品存放在这片开源净土里,供彼此学习交流。GitHub Trending 栏目甚至已经成为 IT 从业人员的新闻日报,每日必读。既然 GitHu_github与gitpod的插件
文章浏览阅读1.1k次。根据VCD文件的type,PTPX支持instantaneous peak power analysis和cycle_accurate peakpower analysis。Time-Based Power Analysis支持的VCD type 由于Gate_level和zero_delay的VCD不支持event propa..._ptpx time
文章浏览阅读79次。VisualSVN安装教程、、、-----------------------------------参考网址:https://www.visualsvn.com/server/download/安装参考网址:http://www.jb51.net/article/71815.htm----------------------------------------------..._安装visualsvn
文章浏览阅读645次。程序员使用的语言有鄙视链吗?有人说有,有人说没有。一个美团员工发帖说,筛选简历时用go语言的基本不看。短短一句话,把对go语言的鄙视体现得淋漓尽致,难道go语言真的不如其他语言?和他一..._go语言的鄙视链
文章浏览阅读5.3k次。在本文中,我将解释如何将ink与Unity项目集成,以及如何使用ink API与我们的小说网站源码系统进行交互。在我们开始之前,请确保您有一个包含一些对话和选择的墨水文件。您可能想下载并使用我准备的示例故事。这实际上是来自Guilt Free的简化场景,通过分享这一点,我想向您展示一个真实的视觉小说系统源码示例和实际代码的技术。完整源码:xsymz.icu项目设置继续在 Unity 中创建一个新的 2D 项目。然后添加您可以在此处找到的墨水插件。在ink插件文件夹(Plugins/Ink)里会有一_小说网站源码
文章浏览阅读531次。参考API Design Guidelineshttps://swift.org/documentation/api-design-guidelines/swift-style-guidehttps://github.com/raywenderlich/swift-style-guide项目命名规范一、工程文件夹、文件目录结构【业务模块】1、文件夹采用下划线命名,名字全部小写下划线间隔,如module_login2、文件、类、结构体、枚举、协议采用大驼峰命名,每个单词首字母大写,如 MyCu_swift 正则判断文件类型
文章浏览阅读2.2w次。1、return命令会使得一个函数返回.return命令会返回一个单一的数字参数, 而这个数字参数在调用这个函数的脚本中是可见的.如果没有指定返回参数,return在默认情况下会返回上一次命令的返回代码。2、了解一个概念:return value ﹗我们在 shell 下跑的每一个 command 或 function ,在结束的时候都会传回父行程一个值,称为 return value 。在 shell command line 中可用 $? 这个变量得到最"新"的一个 return value_shell return
文章浏览阅读834次。本系列文章主要写我在阅读Linux内核过程中,关注的比较难以理解但又设计巧妙的代码片段(不关注OS的各个模块的设计思想,此部分我准备写在“深入理解Linux Kernel”系列文章中),一来通过内核代码复习一下C语言及汇编语言的语法,二来学习内核开发大牛们书写代码的风格及思路。理解了上面之后,再来看看第二个BUILD_BUG_ON_NULL(e)宏,与第一个类似,-------------------------------------完--------------------------------_build_bug_on_zero
文章浏览阅读678次。//调用单片机头文件#define uchar unsigned char //无符号字符型 宏定义 变量范围0~255#define uint unsigned int //无符号整型 宏定义 变量范围0~65535#include "eeprom52.h"#include "nongli.h"bit flag_2..._基于单片机的自动打铃控制系统设计提纲