Code Examples in Javadocs
I wish IntelliJ provided some basic syntax highlighting, completion, and formatting for code examples in Javadocs. What a pain. I'll bet more developers would write them if it did.
Monday, May 01, 2006
Subscribe
Hi. My name is Bob.
I'm a software engineer at Google. I created the Jolt award winning Guice framework. I currently lead the core library development on Android. The opinions expressed on this site are my own and don't necessarily reflect those of my employer yada yada yada.
Previous Posts
- Clapping
- Creative Cropping
- Balloon Popping @ Maker Faire '06
- Why do sites provide both RSS and Atom feeds?
- What do you do during your IntelliJ downtime?
- New Windows
- Flickr Performance
- Quake Clone in Your Browser
- Good Luck, Gilad
- Ouch, McAfee
4 Comments:
You can still get ctl-shift completion within Javadoc.
You should vote for Add code completion in {@code} javadoc tag
Another good idea is to write good code examples in the programmer tests of your component. When figuring out what a component is doing, it's always a good idea to search for its references in the code base, and when tests are found, check them out (though this is not easy to do if you're working with a library without its source code in your IDE.)
If compelled, you can then copy the code from the tests over to the javadocs. But the code in javadocs has the disadvantage of lacking compile- and run-time checking, so it gets out of date more easily than the executable examples in tests.
Anyway, thankyou for raising a good point. I think that I'll consider adding a '@see FooTest' to my code sometimes.
Java continues to be evil!
** Shaun **
My awesome blog: ohpunk.blogspot.com
-
Post a Comment
Links to this post:
Create a Link
<< Home