Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

JetBrains Rider

JetBrains Rider 是一款由 JetBrains 公司推出的付费（商业）IDE，它支持 C++、C# 和 GDScript 开发，并且使用了和 Visual Studio 相同的解决方案（Solution）系统。

备注

这份文档是专门针对为游戏引擎（本体）做贡献的，而不是教你如何把 JetBrains Rider 当作 C# 或 GDScript 的编辑器来使用。如果你是想在外部编辑器里编写 C# 或 GDScript 游戏脚本，请查阅： the C# guide to configure an external editor。

导入项目

小技巧

如果 Visual Studio 已经是你的主要 IDE，那么你可以在 Rider 中使用同一个解决方案文件。Rider 和 Visual Studio 使用相同的解决方案文件格式，所以你可以在两个 IDE 间切换，无需重新构建解决方案文件。切换 IDE 时需要更改调试配置。

如果你是刚开始（从零起步），请参照相关 instructions，尤其是以下几点：

  • 安装所有的依赖项。

  • 弄清楚针对特定平台进行编译的 scons 命令是什么。

为 scons 提供额外的参数，以请求生成解决方案文件。

  • 在 scons 命令后面加上 vsproj=yes dev_build=yes

vsproj 参数表示要生成 Visual Studio 项目文件。而 dev_build 参数则能确保在生成过程中包含调试符号（debug symbols），这样你就可以执行一系列调试操作了，比如使用断点来逐步执行代码。

  • 在 Rider 中打开生成的 godot.sln 文件。

备注

请确保在 Rider 的工具栏上选择了正确的解决方案配置（Solution configuration）。这会影响 SDK 的解析、代码分析、构建、运行等所有操作。

项目的编译与调试

Rider 自带了一个内置调试器，可以用来调试 Godot 项目。你可以直接点击屏幕顶部的 Debug （调试）图标来启动它。不过，这个操作默认只对项目管理器（Project Manager）生效；如果你想要调试 Godot 编辑器本身，就需要先手动配置一下调试器。

../../../_images/rider_run_debug.webp

  • 点击屏幕顶部的 Godot > Edit Configurations （编辑配置）选项。

../../../_images/rider_configurations.webp

  • 请确保 C++ 项目的运行配置（Run Configuration）中包含以下数值（设置）：

    • Exe路径： $(LocalDebuggerCommand)

    • 程序参数：-e --path <path to the Godot project>

    • 工作目录： $(LocalDebuggerWorkingDirectory)

    • Before Launch（启动前）的值为 "Build Project"（构建项目）

这会告诉可执行程序，在不打开项目管理器（Project Manager）的情况下，直接调试指定的项目。请使用项目文件夹的根路径，而不是 project.godot 文件的路径。

../../../_images/rider_configurations_changed.webp

  • 最后，点击 "Apply" 和 "OK" 来保存更改。

  • 当你点击屏幕顶部的 Debug （调试）图标时，JetBrains Rider 就会启动 Godot 编辑器，并且自动挂上调试器。

或者，你也可以使用 运行 > 附加到进程 将调试器附加到运行中的 Godot 实例。

../../../_images/rider_attach_to_process.webp

  • 你可以通过搜索 godot.editor 来找到 Godot 实例，然后点击 Attach with LLDB

../../../_images/rider_attach_to_process_dialog.webp

调试观察器

调试可视化器（Debug visualizers）可以自定义调试时复杂数据结构的显示方式。在 Windows 上，Godot 内置的 "natvis" （'Native Visualization' 的缩写）会自动生效。而在其他操作系统上，类似的功能则需要手动进行设置。

请关注 RIDER-123535。

单元测试

利用 Rider 的 doctest （单元测试）支持。具体操作请参考 the instructions。

性能分析

请参阅 the profiling instructions。

关于 JetBrains IDE 的任何具体信息，请查阅 JetBrains Rider 官方文档 JetBrains Rider documentation 。

已知问题

调试 Windows MinGW 构建版本时 —— 无法加载符号。已报告至 RIDER-106816。