Skip to content

Commit 8d28f0f

Browse files
authored
Merge pull request #10097 from Calinou/gdscript-basics-documentation-comments
Mention documentation comments in GDScript basics
2 parents be9be7f + 594a1d6 commit 8d28f0f

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

tutorials/scripting/gdscript/gdscript_basics.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -572,6 +572,21 @@ considered a comment.
572572
The list of highlighted keywords and their colors can be changed in the **Text
573573
Editor > Theme > Comment Markers** section of the Editor Settings.
574574

575+
Use two hash symbols (``##``) instead of one (``#``) to add a *documentation
576+
comment*, which will appear in the script documentation and in the inspector
577+
description of an exported variable. Documentation comments must be placed
578+
directly *above* a documentable item (such as a member variable), or at the top
579+
of a file. Dedicated formatting options are also available. See
580+
:ref:`doc_gdscript_documentation_comments` for details.
581+
582+
583+
::
584+
## This comment will appear in the script documentation.
585+
var value
586+
587+
## This comment will appear in the inspector tooltip, and in the documentation.
588+
@export var exported_value
589+
575590
Code regions
576591
~~~~~~~~~~~~
577592

0 commit comments

Comments
 (0)