Using Javadoc
(Page 1 of 5 )
The Stat Data Provider Inc. development team scours their code and frantically attempts to piece together a development guide. Unfortunately, they have forgotten the details of how certain portions work. The Javadoc(TM) tool can deter such a situation from showing its ugly face. In this article, the reader is guided through self-documenting code in a structured manner to generate Java(TM) API documentation.
Introduction
Company, Stat Data Provider Inc. has finished development of a new solution, providing statistical data to their customers. This solution includes a large API that allows access to the solution’s robust features. The customer’s development team requests documentation for the API so they may begin integration immediately.
The Stat Data Provider Inc. development team scours their code and frantically attempts to piece together a development guide. Unfortunately, they have forgotten the details of how certain portions work.
Unfortunately, this “mock” situation is an all too common of an occurrence in the real world of software development.
The Javadoc(TM) tool can deter such a situation from showing its ugly face. In this article, the reader is guided through self-documenting code in a structured manner to generate Java(TM) API documentation.
Next: Java Documentation Comments >>
More Java Articles
More By Kulvir S. Bhogal
