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

Improve readability of javadoc #3773

Open
raulvaldoleiros opened this issue Sep 20, 2024 · 6 comments
Open

Improve readability of javadoc #3773

raulvaldoleiros opened this issue Sep 20, 2024 · 6 comments

Comments

@raulvaldoleiros
Copy link

It would be great if we can read the javado in visual studio editor in an human readable format, instead the code format.

Current Result

Reading documentation in this format is hard.
image

Expected Result

Having a away to read it in an human readable format, in all objects (files in vscode or referenced through maven or gradel)

Additional Informations

If this already exists, sorry and please let me know.

@fbricon
Copy link
Collaborator

fbricon commented Sep 20, 2024

you can hover over the class/field/method the javadoc is bound to

@iwangbowen
Copy link

Much needed

@raulvaldoleiros
Copy link
Author

you can hover over the class/field/method the javadoc is bound to

Hi @fbricon , thanks for the suggestion.
You are right, but my use case is a little bit different if I got it correctly. I'm opening classes that extends an interface and trying to read the documentation to understand what they do. I'm opening the javadoc web page to read it the documentation and it would be much better in vscode.

@fbricon
Copy link
Collaborator

fbricon commented Sep 20, 2024

I understand, I was merely suggesting a workaround. I know Jetbrains IDEA as a nice way of showing human-readable javadoc instead of raw html. But I'm not sure if VS Code is capable of doing something similar

Screenshot 2024-09-20 at 15 27 24 Screenshot 2024-09-20 at 15 27 32

@testforstephen @aeschli any idea?

Worst case scenario, we could probably add a command to open a javadoc view

@rgrunber
Copy link
Member

Could we collapse/fold the Javadoc node (server-side AST would give us this) and insert the "rendered" Javadoc as a code lens / inlay hint ?

@SkMoran
Copy link

SkMoran commented Sep 26, 2024

we really need this feature

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

5 participants