Skip to content

Document comment keywords being highlighted in the script editor #8371

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 1, 2023
Merged

Document comment keywords being highlighted in the script editor #8371

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions tutorials/scripting/gdscript/gdscript_basics.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -539,6 +539,30 @@ considered a comment.

# This is a comment.

.. tip::

In the Godot script editor, special keywords are highlighted within comments
to bring the user's attention to specific comments:

- **Critical** *(appears in red)*: ``ALERT``, ``ATTENTION``, ``DANGER``, ``HACK``,
``SECURITY``
- **Warning** *(appears in yellow)*: ``BUG``, ``CAUTION``, ``DEPRECATED``, ``FIXME``,
``TASK``, ``TBD``, ``TODO``, ``WARNING``
- **Notice** *(appears in green)*: ``NOTE``, ``NOTICE``, ``TEST``, ``TESTING``

These keywords are case-sensitive, so they must be written in uppercase for them
to be recognized:

::

# In the example below, "TODO" will appear in yellow by default.
# The `:` symbol after the keyword is not required, but it's often used.

# TODO: Add more items for the player to choose from.

The list of highlighted keywords and their colors can be changed in the **Text
Editor > Theme > Comment Markers** section of the Editor Settings.

.. _doc_gdscript_builtin_types:

Line continuation
Expand Down