Javadoc: Difference between revisions

Revision as of 08:47, 11 October 2024

Revision as of 17:59, 21 November 2024

Line 1:

{{short description|Documentation generator for Java}}

{{manual|date=August 2023}}

'''Javadoc''' is a [[documentation generator]] created by [[Sun Microsystems]] for the [[Java (programming language)|JavaJavau language]] (now owned by [[Oracle Corporation]]) for generating [[Application programming interface|API]] documentation in [[HTML]] format from [[Java (programming language)|Java]] source code. The HTML format is used for adding the convenience of being able to [[hyperlink]] related documents together.<ref>{{cite web |url=http://agile.csc.ncsu.edu/SEMaterials/tutorials/javadoc/ |title=Javadoc |website=agile.csc.ncsu.edu |access-date=12 January 2022 |archive-url=https://web.archive.org/web/20170613233020/http://agile.csc.ncsu.edu/SEMaterials/tutorials/javadoc/ |archive-date=13 June 2017 |url-status=dead}}</ref>

The "doc comments" format<ref>{{cite web|url = http://docs.oracle.com/javase/1.5.0/docs/tooldocs/solaris/javadoc.html|title = javadoc - The Java API Documentation Generator|access-date = 2011-09-30|publisher = [[Sun Microsystems]]}}.</ref> used by Javadoc is the de facto industry standard for documenting Java classes. Some [[Integrated Development Environment|IDE]]s,<ref>[https://www.jetbrains.com/idea/ IntelliJ IDEA], [http://www.netbeans-blog.org/netbeans-ide/generating-javadoc-for-a-project-in-netbeans-ide.html NetBeans] {{Webarchive|url=https://web.archive.org/web/20170405230224/http://www.netbeans-blog.org/netbeans-ide/generating-javadoc-for-a-project-in-netbeans-ide.html |date=2017-04-05 }} and [http://www.eclipse.org/ Eclipse]</ref> like [[IntelliJ IDEA]], [[NetBeans]] and [[Eclipse (software)|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.