Merge pull request #10295 from tetrapod00/gdscript-summary

Add GDScript naming convention summary table
godotengine · Nov 21, 2024 · 5b15d19 · 5b15d19
2 parents b82187d + c1310e6
commit 5b15d19
Showing 1 changed file with 23 additions and 1 deletion.
diff --git a/tutorials/scripting/gdscript/gdscript_styleguide.rst b/tutorials/scripting/gdscript/gdscript_styleguide.rst
@@ -620,7 +620,29 @@ Naming conventions
 
 These naming conventions follow the Godot Engine style. Breaking these will make
 your code clash with the built-in naming conventions, leading to inconsistent
-code.
+code. As a summary table:
+
++---------------+----------------+----------------------------------------------------+
+| Type          | Convention     | Example                                            |
++===============+================+====================================================+
+| File names    | snake_case     | ``yaml_parser.gd``                                 |
++---------------+----------------+----------------------------------------------------+
+| Class names   | PascalCase     | ``class_name YAMLParser``                          |
++---------------+----------------+----------------------------------------------------+
+| Node names    | PascalCase     | ``Camera3D``, ``Player``                           |
++---------------+----------------+----------------------------------------------------+
+| Functions     | snake_case     | ``func load_level():``                             |
++---------------+----------------+----------------------------------------------------+
+| Variables     | snake_case     | ``var particle_effect``                            |
++---------------+----------------+----------------------------------------------------+
+| Signals       | snake_case     | ``signal door_opened``                             |
++---------------+----------------+----------------------------------------------------+
+| Constants     | CONSTANT_CASE  | ``const MAX_SPEED = 200``                          |
++---------------+----------------+----------------------------------------------------+
+| Enum names    | PascalCase     | ``enum Element``                                   |
++---------------+----------------+----------------------------------------------------+
+| Enum members  | CONSTANT_CASE  | ``{EARTH, WATER, AIR, FIRE}``                      |
++---------------+----------------+----------------------------------------------------+
 
 File names
 ~~~~~~~~~~