how can you open a custom documentation for your script? | GDQuest | Page 1

copper crown Mar 11, 2023, 12:50 PM

#

I'm following this documentation on GDScript 2 but I can't find anywhere that says how to actually open it https://docs.godotengine.org/en/stable/tutorials/scripting/gdscript/gdscript_documentation_comments.html

Godot Engine documentation

GDScript documentation comments

In GDScript, comments can be used to document your code and add description to the members of a script. There are two differences between a normal comment and a documentation comment. Firstly, a do...

white star Mar 11, 2023, 12:59 PM

#

press F1 to search for help and search for your class_name or script file name.

If it doesn't appear there, there is currently a bug with it https://github.com/godotengine/godot/issues/72406, try to do a small change in the script, and undo it and then save to force the script to be updated and the documentation generated again. Usually commenting/uncommenting any line with ctrl+k and saving works

GitHub

Issues · godotengine/godot

Godot Engine – Multi-platform 2D and 3D game engine - Issues · godotengine/godot

copper crown Mar 11, 2023, 1:10 PM

#

thank you!

#how can you open a custom documentation for your script?