I thought I would try coming up with a list of "who, what , where, when, why, and how" questions that could be used to help developers write comprehensive Javadoc comments. I've made my current list available as a Google document.
http://docs.google.com/Doc?id=df5nfmf8_58hrw7v8c8 I'm not suggesting we use this for OpenJUMP, but I thought others might find it useful in their own programming. Note: In theory Javadoc provides a "black box" view of an API. This means it does not reveal details about implementation. I have violated this principle with several of the questions in my list. I felt justified in this, since Javadoc comments are often the only type of documentation Java source code gets. I thought I should warn the Javadoc purists about this. :] The Sunburned Surveyor ------------------------------------------------------------------------- This SF.net email is sponsored by: Microsoft Defy all challenges. Microsoft(R) Visual Studio 2008. http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/ _______________________________________________ Jump-pilot-devel mailing list Jump-pilot-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/jump-pilot-devel
