Repository navigation
Improve readability of javadoc #3773
Description
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.
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.
Reacted by Imad ABIED, Marko Milic and yeoleobun
Activity
fbricon commentedon Sep 20, 2024
you can hover over the class/field/method the javadoc is bound to
iwangbowen commentedon Sep 20, 2024
Much needed
raulvaldoleiros commentedon Sep 20, 2024
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 commentedon 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
@testforstephen @aeschli any idea?
Worst case scenario, we could probably add a command to open a javadoc view
rgrunber commentedon Sep 23, 2024
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 ?
AsyncK278 commentedon Sep 26, 2024
we really need this feature
nerfi58 commentedon Dec 20, 2025
Any updates on this?
fbricon commentedon Jan 14, 2026
javadoc-tools has a JavaDoc Preview view, you can move around: