C# - How to add documentation to global classes?

te1ny · March 8, 2025, 9:10am

Godot Version 4.4

Question

I want to add documentation for the Component class and its derivatives to make it easier in the future. But I found only wiki article for GDScript and I don’t understand how to make documentation for C# script.

pmoosi · March 8, 2025, 2:03pm

As far as I’m aware this is currently not possible. There is a proposal:

github.com/godotengine/godot-proposals

Add support for generating class reference descriptions from C# documentation comments

opened 02:30AM - 27 Oct 23 UTC

Mantissa-23

topic:editor topic:dotnet

### Describe the project you are working on Currently working on a movement sho…oter, but this applies to _any_ project using C#. ### Describe the problem or limitation you are having in your project C# docstrings do not apply to inspector property documentation-on-hover, unlike [GDScript documentation comments](https://docs.godotengine.org/en/stable/tutorials/scripting/gdscript/gdscript_documentation_comments.html). ### Describe the feature / enhancement and how it helps to overcome the problem or limitation Seeing docstrings in the inspector is valuable for both solo devs, and particularly for teams, where nontechnical team members often need to interact with classes generated by programmers, and the name of a property alone may not fully describe its functionality. ### Describe how your proposal will work, with code, pseudo-code, mock-ups, and/or diagrams While I'm unclear on the implementation details, the end-goal is fairly straightforward- Bring C# documentation comments to feature parity with GDScript documentation comments. ### If this enhancement will not be used often, can it be worked around with a few lines of script? Not that I'm aware of. ### Is there a reason why this should be core and not an add-on in the asset library? For the same reason that both C# and GDScript documentation comments are core.