14

Is there a plugin to Eclipse (or Visual Studio) which renders javadoc (or doxygen) in place, i.e. there is a pretty print in code instead of displaying javadoc source as comment?

By default it is possible just to fold method body. It could be usefull to have a toggle: full source, source and rendered javadoc, pure rendered javadoc.

Said plugin could generate something looking like this:

user2622016
  • 6,060
  • 3
  • 32
  • 53
  • 3
    Hi, maybe the Javadoc view (ALT+SHIFT+Q J) would be close to your requirements. On the other hand. If pretty printing for javadoc would be included in the editor. How would you change the javadoc? – SubOptimal Aug 08 '13 at 11:32
  • 3
    Edit after switching the toggle: full source, i.e. source code and javadoc as code comment. The whole idea is to have documentation by default displayed in code inline, without need to open any popups or additional windows. We can take a look at this extension to Visual Studio [Image Insertion](http://visualstudiogallery.msdn.microsoft.com/793d16d0-235a-439a-91df-4ce7c721df12). They have whole images in code, maybe there is some extension rendering Rich-text or doxygen in place? – user2622016 Aug 08 '13 at 15:16
  • I think an editor should focus on the code as it is written and maintained by the coder. So extra's like the image insertion of visual studio detracts the coder from what they are doing. An extra view like the one in eclipse keeps the focus correct. And with a mouse over on the method, you also get to see the rendered javadocs. So, no need for extra fancy stuff in the editor itself. – Salandur Aug 22 '13 at 08:39
  • 1
    I'd like this feature so I can easier browse someone else's source code, and review my own javadoc and source in one. And sure would be something you'd toggle on and off so you can edit. – Dave Moten Jun 15 '15 at 20:36

1 Answers1

2

Yes there is. In eclipse, just open or select the javadoc view and go to your own method

Salandur
  • 6,409
  • 2
  • 22
  • 23