NetBeans Forums

 FAQFAQ   SearchSearch   MemberlistMemberlist   RegisterRegister   ProfileProfile   Log in to check your private messagesLog in to check your private messages   Log inLog in 
  

Inline HTML editor / renderer for javadoc in the code editor window

 
Post new topic   Reply to topic    NetBeans Forums -> NetBeans Users
View previous topic :: View next topic  
Author Message
emc



Joined: 10 Dec 2009
Posts: 1

PostPosted: Thu Dec 10, 2009 8:30 pm    Post subject: Inline HTML editor / renderer for javadoc in the code editor window Reply with quote

Wish list \ Suggestion:

Being able to have the code documentation right along with the code is maintenance bliss. There is little chance of losing the documentation and an increased likelihood that the documentation stays current with the code.

It would be great if Netbeans could increase the usefulness of javadoc style comments (/** javadoc */) by rendering them in HTML directly in the code editor window. To edit the javadoc you could provide a toggle that switches between raw javadoc comments and javadoc HTML rendering.

You could take this concept further allow inline HTML WYSIWYG editing when the javadoc comment is being rendered as HTML.

This allows more sophisticate and expressive documentation that is readable in code. Comments with formatting and tabular structures (eg truth tables etc) can be just as easily read and modified in code as in any generated javadoc.

Further enhancements could include inline rendering / editing support for:
- mathML support which is needed for a lot a graphics and mathematical functions
- SVG support for complex algorithms (picture is worth a 1000 words).
Back to top
Display posts from previous:   
Post new topic   Reply to topic    NetBeans Forums -> NetBeans Users All times are GMT
Page 1 of 1

 
Jump to:  
You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot vote in polls in this forum
You cannot attach files in this forum
You can download files in this forum


Powered by phpBB
By use of this website, you agree to the NetBeans Policies and Terms of Use. © 2012, Oracle Corporation and/or its affiliates. Sponsored by Oracle logo