Add Syntax Highlighting for TODO, FIXME, etc.

[henzelennard]

Not sure if this is the right place to put this. I thought it would be nice to have syntax highlighting for keywords like TODO, FIXME, etc. similar to the build in editor. As fast as I could tell something like this does not exist yet. Any thoughts on the idea?

[DaelonSuzuka]

Sounds like you didn't bother searching the extension marketplace:

https://marketplace.visualstudio.com/items?itemName=aaron-bond.better-comments
https://marketplace.visualstudio.com/items?itemName=ParthR2031.colorful-comments

[henzelennard]

Thanks for getting back to me. I am aware that there are other extensions available that do that.

I think it would be great to have this built into the godot-vscode-plugin since the built-in editor already provides this highlighting by default, making it a sort of feature of the language. Additionally, Godot has a quite strict ruleset for applying highlighting. Incorporating the same logic into the official plugin would enable enforcing (or at least defaulting to) the same standards, thus automatically unifying the code base when working with multiple developers.

In my opinion this would be particularly useful for teams where some members prefer working with the built-in code editor and others with VSCode.

[DaelonSuzuka]

Then you add colorful-comments to the recommended extensions in your project, and you commit a shared config for it in .vscode/settings.json and then all your team members will see the same highlighting.

[Calinou]

I think it would be great to have this built into the godot-vscode-plugin since the built-in editor already provides this highlighting by default, making it a sort of feature of the language.

It technically isn't a language feature, just a convenience feature the GDScript highlighter in the script editor happens to implement.

I suppose the closest analog would be Swift's // MARK: comments, which draw horizontal lines in Xcode but not many other editors implement it.

[henzelennard]

Thanks for your feedback! I went ahead and added the syntax highlighting on a fork of the godot-vscode-plugin to meet the needs of my team. If there’s ever interest in integrating this into the main repo, I’m happy to create a PR. Otherwise, I’ll keep maintaining the fork for us.

Here’s the link if you want to check it out.