Skip to content

Commit

Permalink
Mention documentation comments in GDScript basics
Browse files Browse the repository at this point in the history
  • Loading branch information
Calinou committed Oct 16, 2024
1 parent 26769a6 commit 0974145
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions tutorials/scripting/gdscript/gdscript_basics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -572,6 +572,12 @@ 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
~~~~~~~~~~~~

Expand Down

0 comments on commit 0974145

Please sign in to comment.