In this article, we illustrated how the Javadoc tool from Sun Microsystems, Inc. generates API documentation. The documentation is a reflection of the doc comments placed in the source code as shown through our exercise. Commenting code is unfortunately a task that often receives low priority or delayed until ‘later’. Using doc comments throughout the development cycle and leveraging the Javadoc tool, developers can generate structured API documentation that fellow developers can understand readily.
| DISCLAIMER: The content provided in this article is not warranted or guaranteed by Developer Shed, Inc. The content provided is intended for entertainment and/or educational purposes in order to introduce to the reader key ideas, concepts, and/or product reviews. As such it is incumbent upon the reader to employ real-world tactics for security and implementation of best practices. We are not liable for any negative consequences that may result from implementing any information covered in our articles or tutorials. If this is a hardware review, it is not recommended to open and/or modify your hardware. |
