godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-03 05:48:42 +03:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #10097 from Calinou/gdscript-basics-documentation-comments

Browse Source 
Mention documentation comments in GDScript basics
This commit is contained in:
Max Hilbrunner
2024-10-18 05:33:23 +02:00
committed by GitHub
parent be9be7fb28 594a1d6cbc
commit 8d28f0fc82
1 changed files with 15 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
tutorials/scripting/gdscript/gdscript_basics.rst
View File

@@ -572,6 +572,21 @@ considered a comment.
The list of highlighted keywords and their colors can be changed in the **Text
Editor > Theme > Comment Markers** section of the Editor Settings.
Use two hash symbols (``##``) instead of one (``#``) to add a *documentation
comment*, which will appear in the script documentation and in the inspector
description of an exported variable. Documentation comments must be placed
directly *above* a documentable item (such as a member variable), or at the top
of a file. Dedicated formatting options are also available. See
:ref:`doc_gdscript_documentation_comments` for details.
::
## This comment will appear in the script documentation.
var value
## This comment will appear in the inspector tooltip, and in the documentation.
@export var exported_value
Code regions
~~~~~~~~~~~~