How to create Javadoc comments
![Image](https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEiRnLBZL4C1QbPdyzgSfnS95VDr5UvU-azJtfO7iayP9nbeOLYDsKy_tuset0rQf62Y4xT-cSrzZx7rW_GYy6dHNv1GQQKTZDdO0ClOj6J2RElEY_CoVlR_l-Rthi4zTYa7PXzS4EUhgJs/s550/MyStackJavadocHover.png)
This document is a summary of the information found on the Oracle website: http://www.oracle.com/technetwork/java/javase/documentation/index-jsp-135444.html My goal is to give you a summarized version of the following topics: · What is Javadoc and why is it needed? · How to document your code using Javadoc · How to generate Javadoc documentation · How to publish Javadoc What is Javadoc and why is it needed? In simple terms, Javadoc is a tool for documenting your code in HTML format. Because this documentation is in HTML, it can be easily uploaded to a web server and made available online for the whole world to see. An example of this is the Java API ( https://docs.oracle.com/javase/8/docs/api/ ). For many developers, one of the selling points of Java over other languages like C++ was in fact Javadoc. Why? If you consider one of the most common libraries in C++, stdio, most of the documentation found online is