Lately at work we've been emphasizing Javadoc more. I here's a couple of things that I noticed Eclipse will do to make it easier to create Javadoc.
- if you type /** above a function then press Enter, then Eclipse will generate a Javadoc skeleton for that function
- Eclipse will also auto format your Javadoc content after you type it in. Type in the content from the Javadoc skeleton. Then select the Javadoc comment block and press Ctrl+Shift+F and Eclipse will do a pretty good job formatting it. So you don't have to manually edit your Javadoc for indents, column width, and line wraps. Just type in the content and get Eclipse to format it.
--
I sent the above around to the developers at the office. Like my note before about Google desktop search, a few people appreciated it. I find it's good when you discover some tips about your work environment to send them around to your co-workers. You'd be surprised what people don't know and aren't using.
No comments:
Post a Comment