Why are the words BUG, DEPRECATED and TEST highlighted in documentation comments source code

Help Programming
,
1

Godot Version

v4.6.2.stable.double.custom_build

Question

The other day I was working on a big project. I rewrote a part of some gdscript code file and added ## DEPRECATEDabove an exported variable to preserve it as a backup until the rewrite was done. TheDEPRECATEDword was surprisingly highlighted in orange and I tried out some other software vocabulary to see if there are more words and found BUG and TEST (the latter colored in green). There is nothing about this in the documentation GDScript documentation comments — Godot Engine (stable) documentation in English . This color does not have an effect on the tooltip text in the Inspector though unlike @experimental and similar annotations. What is the actual purpose of this and are there more words with this coloring?

{D202EB73-9CF1-47CB-AE7A-B9A54FB81105}

{ED99DF17-8058-4830-88E0-D27FA18B41BA}
{ED99DF17-8058-4830-88E0-D27FA18B41BA}372Ă—212 10.8 KB

2

These are #comments

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, CAUTION, CRITICAL, DANGER, SECURITY

  • Warning (appears in yellow): BUG, DEPRECATED, FIXME, HACK, TASK, TBD, TODO, WARNING

  • Notice (appears in green): INFO, NOTE, NOTICE, TEST, TESTING

3

Probably shouldn’t be highlighted in doc comments though