@@ -8,7 +8,7 @@ JetBrains Rider
8
8
9
9
.. note ::
10
10
11
- This documentation is for contributions to the game engine, and not using
11
+ This documentation is for contributing to the game engine, not for using
12
12
JetBrains Rider as a C# or GDScript editor. To code C# or GDScript in an external editor, see
13
13
:ref: `the C# guide to configure an external editor <doc_c_sharp_setup_external_editor >`.
14
14
@@ -29,7 +29,7 @@ Provide scons with additional arguments to request a solution file generation:
29
29
- Add `vsproj=yes dev_build=yes ` to the scons command
30
30
31
31
The ``vsproj `` parameter signals that you want Visual Studio solution generated.
32
- The ``dev_build `` parameter makes sure the debug symbols are included, allowing to e.g. step through code using breakpoints.
32
+ The ``dev_build `` parameter ensures the debug symbols are included, allowing to e.g. step through code using breakpoints.
33
33
34
34
- Open the generated ``godot.sln `` in Rider.
35
35
@@ -38,7 +38,7 @@ The ``dev_build`` parameter makes sure the debug symbols are included, allowing
38
38
Compiling and debugging the project
39
39
-----------------------------------
40
40
Rider comes with a built-in debugger that can be used to debug the Godot project. You can launch the debugger
41
- by pressing the **Debug ** icon at the top of the screen, this only works for the Project manager ,
41
+ by pressing the **Debug ** icon at the top of the screen, this only works for the Project Manager ,
42
42
if you want to debug the editor, you need to configure the debugger first.
43
43
44
44
.. figure :: img/rider_run_debug.webp
@@ -56,7 +56,7 @@ if you want to debug the editor, you need to configure the debugger first.
56
56
- Working Directory: ``$(LocalDebuggerWorkingDirectory) ``
57
57
- Before Launch has a value of "Build Project"
58
58
59
- This will tell the executable to debug the specified project without using the project manager .
59
+ This will tell the executable to debug the specified project without opening the Project Manager .
60
60
Use the root path to the project folder, not ``project.godot `` file path.
61
61
62
62
.. figure :: img/rider_configurations_changed.webp
@@ -80,15 +80,15 @@ Alternatively you can use **Run > Attach to Process** to attach the debugger to
80
80
81
81
Debug visualizers
82
82
-----------------
83
- Debug visualizers define how complex data structures are displayed in the debugger .
83
+ Debug visualizers customize how complex data structures are displayed during debugging .
84
84
For Windows "natvis" (short for "Native Visualization") built-in with Godot are automatically used.
85
- For other operating systems a similar functionality can be enabled separately .
85
+ For other operating systems, similar functionality can be setup manually .
86
86
87
87
Please follow `RIDER-123535 <https://youtrack.jetbrains.com/issue/RIDER-123535/nix-Debug-Godot-Cpp-from-Rider-pretty-printers-usability >`_.
88
88
89
89
Unit testing
90
90
------------
91
- Utilize Rider :ref: `doctest<doc_unit_testing> ` support.
91
+ Leverage Rider :ref: `doctest<doc_unit_testing> ` support.
92
92
Please follow `RIDER-122019 <https://youtrack.jetbrains.com/issue/RIDER-122019/Godot-doctest-Unit-Tests-Stuck-in-pending >`_.
93
93
94
94
Profiling
0 commit comments