Content deleted Content added
Stevebroshar (talk | contribs) →Design: This section is not really about design; not in typical meanings of design; renaming to markup |
No edit summary |
||
Line 1:
{{short description|Documentation generator for Java}}
{{how-to|date=August 2023}}
'''Javadoc''' (also capitalized as '''JavaDoc''' or '''javadoc''') is an [[Application programming interface|API]] [[documentation generator]] for the [[Java (programming language)|Java programming language]]. Based on information in Java [[source code]], Javadoc generates documentation formatted as [[HTML]] and via [[Plug-in (computing)|extensions]], other formats.<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> Javadoc was created by [[Sun Microsystems]] and is owned by [[Oracle Corporation|Oracle]] today.
The content and formatting of a resulting document are controlled via special [[Markup language|markup]] in source code [[Comment (computer programming)|comments]]. As this markup is [[de facto standard]] and ubiquitous for documenting Java code,<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> many [[Integrated Development Environment|IDE]]s extract and display the Javadoc information while viewing the source code; often via hover over an associated symbol. Some IDEs, like [[IntelliJ IDEA]], [[NetBeans]] and [[Eclipse (software)|Eclipse]], support generating Javadoc template comment blocks.<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> The <code>@tag</code> syntax of Javadoc markup has been re-used by other documentation generators, including [[Doxygen]], [[JSDoc]], [https://www.erlang.org/doc/apps/edoc/chapter.html EDoc] and [[HeaderDoc]].
Line 88:
void doMove(int fromFile, int fromRank, int toFile, int toRank) { ... }
</syntaxhighlight>
== Markdown ==
From Java 23 onwards, Javadoc supports the [[Markdown]] standard CommonMark on comment lines that start with <code>///</code> instead of the older multiline format. <ref>https://openjdk.org/jeps/467</ref>
== Doclets ==
| |||