Skip to content
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.

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

Assign inline comment of an export variable to its inspector hover annotation #2413

Closed
chepulis opened this issue Mar 6, 2021 · 1 comment

Comments

@chepulis
Copy link

chepulis commented Mar 6, 2021

Describe the project you are working on

A medium-sized indie game, irrelevant to the proposal. It has lots of scripts.

Describe the problem or limitation you are having in your project

Export variables can be documented in scripts — invisible from the editor inspector.

Describe the feature / enhancement and how it helps to overcome the problem or limitation

This is an inspector variable that displays a useful annotation on hover:
image

This is a custom export variable i've created in my script:
image
It has a useful inline comment documenting its function.

That comment could be displayed here:
image

And that would make everybody's life a little easier. Especially when the work is done in teams.

Describe how your proposal will work, with code, pseudo-code, mock-ups, and/or diagrams

Whoever is redeveloping GDScript can, i'm guessing, include these comments. @vnen?

If this enhancement will not be used often, can it be worked around with a few lines of script?

It's a minor usability improvement, the workaround is the status quo. But it is something that will deliver bits of utility very often.

Is there a reason why this should be core and not an add-on in the asset library?

It's GDScript and editor. As core as it gets.

@YuriSizov
Copy link
Contributor

YuriSizov commented Mar 6, 2021

Code documentation was already implemented in 4.0 based on #993 in godotengine/godot#41095

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants