redhat-developer / vscode-java

Java Language Support for Visual Studio Code
Eclipse Public License 2.0
2.08k stars 442 forks source link

Improve readability of javadoc #3773

Open raulvaldoleiros opened 1 month ago

raulvaldoleiros commented 1 month ago

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 commented 1 month ago

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

iwangbowen commented 1 month ago

Much needed

raulvaldoleiros commented 1 month ago

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 commented 1 month ago

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 commented 1 month ago

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 commented 1 month ago

we really need this feature