Creating source code documentation

Source codes usually are documented by comments inserted at positions in the code where the author thought an explanation of what is done there might be needed or otherwise helpful.

If such comments are created following a certain syntax, they can be translated to a set of API documentation files in HTML with the Javadoc tool of the Java Software Development Kit. For details about Javadoc please refer to page 'Javadoc 1.4 Tool' at http://java.sun.com/j2se/1.4/docs/tooldocs/javadoc/index.html

Generally it is a good idea and common practice to comment Java source codes following Javadoc syntax as almost automatically there will be a very transparent and thorough documentation of the sources openly viewable with nothing more than a browser.

With application SimplyHTML this has been done too, so there is a set of API documentation files in directory doc of the SimplyHTML distribution package. By opening file index.html the documentation can be viewed with any browser.