‹The template Manual is being considered for merging.›
 | This article is written like a manual or guide. (August 2023) |
Javadoc is a documentation generator created by Sun Microsystems for the Java language (now owned by Oracle Corporation) for generating API documentation in HTML format from Java source code. The HTML format is used for adding the convenience of being able to hyperlink related documents together.[1]
The "doc comments" format[2] used by Javadoc is the de facto industry standard for documenting Java classes. Some IDEs,[3] like IntelliJ IDEA, NetBeans and Eclipse, automatically generate Javadoc templates. Many file editors assist the user in producing Javadoc source and use the Javadoc info as internal references for the programmer.
Javadoc also provides an API for creating doclets and taglets, which allows users to analyze the structure of a Java application. This is how JDiff can generate reports of what changed between two versions of an API.
Javadoc does not affect performance in Java as all comments are removed at compilation time. Writing comments and Javadoc is for better understanding the code and thus better maintaining it.
- ^ "Javadoc". agile.csc.ncsu.edu. Archived from the original on 13 June 2017. Retrieved 12 January 2022.
- ^ "javadoc - The Java API Documentation Generator". Sun Microsystems. Retrieved 2011-09-30..
- ^ IntelliJ IDEA, NetBeans Archived 2017-04-05 at the Wayback Machine and Eclipse