No, I don't miss that... Again, properly configuring the IDE will give you all that as well. For example, turn on the setting to flag missing or malformed JavaDoc as warning or even error if your group takes it very seriously. Well, if I didn't have a "more advanced IDE", I would miss that... ;-)
Absolutely, docs should be generated and reviewed regularly along with the other reports from the nightly build (static analysis reports should be reviewed more frequently). Running JavaDoc every hour wouldn't have ever benefited my projects, but YMMV! A nightly build with JavaDoc, JXR, multiple static analysis reports (and smaller but important rule sets that will fail the build) are one of the first things I setup on my projects (as a consultant, I regularly do them). As well as using them "real-time" with IDE plugins. On Tue, Aug 9, 2011 at 8:47 AM, Mark H. Wood <[email protected]> wrote: > Yes, you *could* rely on your IDE to show you the Javadoc *for the > class or method you're currently focused on*. But then you'd miss > seeing that you forgot to write the overview, you forgot to write most > of the package comments, or that 80% of your classes and methods have > either no topic sentence, a useless one, or one that is bizarrely > formatted and unreadable. Or the amount of material that doesn't > really say anything which would help someone not already intimately > familiar with the code. Documentation should be generated and > reviewed regularly. > > -- > Mark H. Wood, Lead System Programmer [email protected] > Asking whether markets are efficient is like asking whether people are > smart. >
