GDScript代码风格规范参考(1)

发布时间:2026-08-05 00:02   浏览量:1
朱某的生活印记
没有销声匿迹,我在热爱生活
在Godot引擎的生态中,GDScript以其极简的语法和与引擎的深度绑定而备受青睐。然而,当项目规模逐渐扩大时,缺乏规范的代码往往会成为团队协作和后期维护的噩梦。
而在Godot官方文档中,对于代码风格的规范较模糊且散落在各处,代码范例存在非最佳实现的情况。因此,本系列指南将从实战出发,以我这两年来踩过的坑,梳理一套符合现代游戏开发标准的GDScript规范,并分享那些能大幅提升开发效率的高级技巧。
命名规范
变量与函数(包括参数)
所有变量与函数应使用蛇形命名(snake_case)。
所有的变量名和函数名都应该使用全小写字母,单词之间用下划线连接。这种方式在视觉上最为清晰,也是 GDScript 的官方推荐风格。

个人建议
对于一些特殊情况文档中没有明确说明,我个人建议使用如下形式
如果一个变量是中间值的话我建议使用_var形式,参数或变量与自有函数/变量重名的话使用_var_,函数重名__func__的形式来区分。

类名与信号
类名(包括通过  class_name  声明的自定义类)和信号名必须应使用帕斯卡命名法(PascalCase),在官方文档中各种范例也都是使用此形式命名

私有成员
虽然 GDScript 没有严格的访问控制修饰符,但通过在变量或函数名前加下划线_,可以明确告诉其他开发者:“这是一个内部实现细节,请勿在外部直接调用”。官方文档中也提到过这一点。
静态类型
目前GDScript对静态类型支持已经非常完善
但许多初学者仍倾向于使用动态类型(不声明变量类型),我强烈建议全面使用静态类型。这不仅能让代码意图一目了然,还能充分利用编辑器的自动补全功能,并在运行前捕获潜在的类型错误。
此外 我们应使用箭头操作符来声明函数的返回值类型,可以避免很多问题,此处不多赘述。
输入获取的方式

全场景内的快捷键(只需要监听一次输入事件的触发):我建议使用_input()来获取
移动输入(需要支持长按功能的输入):我建议使用_physics_process()来获取
其他:可以使用_process()来获取

总的来说,遵循上述规范与技巧,你的GDScript代码可能不会有太明显的性能提升但这将会辅助开发文档使其更加易读易懂
查看原文

该站点最新相关文章