vscode-java icon indicating copy to clipboard operation
vscode-java copied to clipboard

Improve readability of javadoc

Open raulvaldoleiros opened this issue 1 year ago • 6 comments

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.

raulvaldoleiros avatar Sep 20 '24 09:09 raulvaldoleiros

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

fbricon avatar Sep 20 '24 11:09 fbricon

Much needed

iwangbowen avatar Sep 20 '24 12:09 iwangbowen

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.

raulvaldoleiros avatar Sep 20 '24 12:09 raulvaldoleiros

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

fbricon avatar Sep 20 '24 13:09 fbricon

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 ?

rgrunber avatar Sep 23 '24 14:09 rgrunber

we really need this feature

SkMoran avatar Sep 26 '24 04:09 SkMoran

Any updates on this?

nerfi58 avatar Dec 20 '25 23:12 nerfi58