From bef0e50a64d12aa4188bcc2aeb80a94f45b1ae5e Mon Sep 17 00:00:00 2001 From: Hugo Locurcio Date: Wed, 16 Oct 2024 17:47:03 +0200 Subject: [PATCH] Mention documentation comments in GDScript basics --- tutorials/scripting/gdscript/gdscript_basics.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/tutorials/scripting/gdscript/gdscript_basics.rst b/tutorials/scripting/gdscript/gdscript_basics.rst index 97375d92a61..3874b2a2e81 100644 --- a/tutorials/scripting/gdscript/gdscript_basics.rst +++ b/tutorials/scripting/gdscript/gdscript_basics.rst @@ -572,6 +572,13 @@ 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. +It is also possible to mark certain comments as +:ref:`documentation comments ` by using +two hash symbols (``##``) instead of one (``#``). This only has an effect for +comments placed immediately *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. + Code regions ~~~~~~~~~~~~