为类参考手册贡献

类参考可以在在线文档的章节中查看,也可以在 Godot 编辑器的帮助菜单中打开。

类参考中,有一些方法、变量、信号缺少描述。还有一些在最近的发布中发生了改变,需要更新。开发者们无法自行编写所有参考。Godot 需要你,需要大家一起作出贡献。

重要:如果你准备进行大量修改,就应该在 godot-docs 仓库中创建 Issue,或者在已有 Issue 上发表评论。这样别人就会知道你准备处理某个类了。

参见

你可以在这里找到类参考手册的编写规范。

至于 Git 用法及拉取请求工作流程的详细信息,请参阅 拉取请求工作流程 页面。

如果你想把类参考手册从英文翻译到其他语言,请参见 编辑器和文档本地化

本指南也在 YouTube 上以视频教程的形式提供。

参见

不知道从哪里开始作出贡献?请在这里查看当前的类参考的完成状态。

你可以在 Godot 的 GitHub 仓库中找到类参考的源文件:doc/classes/

备注

游戏引擎中某些模块的 XML 文件在 modules/<模块名称>/doc_classes/ 目录下。

警告

请总是使用这些 XML 源文件来编辑 API 参考。请勿编辑托管在 godot-docs 仓库,为在线文档生成的 .rst 文件。

警告

除非你只需要做一些微笑的修改,比如修正一个拼写错误,否则我们不建议你使用 GitHub 的网页编辑器去编辑类参考文档的 XML。

它缺少方便编辑 XML 的功能,比如没法保持缩进的一致性,也不允许根据审核意见修订提交。

而且,你也没法在引擎中测试你的修改,也不能像 如何编辑类 XML 中描述的一样使用校验脚本。

更新文档模板

当你为引擎创建了一个新的类、或者修改了引擎的 API 时,你需要重新生成 doc/classes/ 中的 XML 文件。

为了达到这个目的,你首先需要编译 Godot。方法请参阅 构建系统介绍 页面。然后,在 Godot 根目录中使用 --doctool 选项运行编译出的 Godot 二进制文件。例如,在 64 位 Linux 下,命令为:

./bin/godot.linuxbsd.tools.64 --doctool

在 doc/classes 中的 XML 文件此时应该是与当前 Godot 引擎的特性一致的。你可以使用 git diff 查看不同之处。请让你的提交仅包含与你修改的 API 相关的改动。可以使用 git checkout 放弃对其他 XML 文件的修改。