Java theory and practice, I have to document THAT?

Integrated documentation a la Javadoc is both a benefit and a burden

From the developerWorks archives

Brian Goetz

Date archived: February 27, 2017 | First published: August 01, 2002

The Java language takes an integrated approach to API documentation through the Javadoc comment convention. The Javadoc tool can help generate pretty API documentation, but the vast majority of Java API documentation out there is simply awful. Because it is part of the source code, the responsibility for the documentation of APIs falls squarely on the engineer. In this article, Brian rants about the current state of Java documentation practices and offers some guidelines on how to write more useful Javadoc.

This content is no longer being updated or maintained. The full article is provided "as is" in a PDF file. Given the rapid evolution of technology, some steps and illustrations may have changed.



static.content.url=http://www.ibm.com/developerworks/js/artrating/
SITE_ID=1
Zone=Java development
ArticleID=10691
ArticleTitle=Java theory and practice: I have to document THAT?
publish-date=08012002