|
|
05.19.2005 |
|
||||||||||
| Eclipse Code Documentation | ||||||||||||
I've been a computer geek since a boy, and thoughts related to computers and software engineering get dropped here for the benefit of humanity and my own hubris.
|
Often I’ll be looking at a piece of code like the following: doc.appendChild( doc.importNode( root, true ) ); And I’ll think, “What da hell does ‘true’ mean?” In this particular case, I wrote it, but still, I expect my IDE to quickly explain all about the “importNode” method (for instance). Eclipse does this if you click on the method, and then hit the ‘F2’ key. However, it typically only knows about methods that are part of the standard Java distribution, and wouldn’t know anything about special libraries you might be calling. So, do the following steps:
Now, ‘F2’ is a brief summary and may not be too helpful, but if you hit ‘Shift-F2’, it will pull up the right Javadoc file in your browser full of hyperlinks and more good stuff. Another idea is to add the ‘Javadoc’ editor (via ‘Window -> Show View -> Javadoc’) and whatever you click on, will have its Javadoc show up in a window at the bottom of your screen. Thought originally posted on Thursday, 19 May 2005
© 2005, Howard Abrams • Except where otherwise noted, all original content is licensed under a Creative Commons License (see details). |
|||||||||||
|
||||||||||||