Javadoc: Difference between revisions

Revision as of 10:54, 9 January 2025

Revision as of 10:58, 9 January 2025

Line 3:

'''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]].

Javadoc alsosupports providesextension an API for creatingvia [[doclets]] and taglets, which allowsallow usersfor togenerating analyzedifferent theoutput structureformats and for [[static analysis]] of a Java application[[codebase]]. ThisFor is howexample, JDiff can generate reports of what changedchanges between two versions of an API.

Javadoc does not affect the performance of a Java executable since comments are ignored by the compiler.

Line 18:

|access-date=2013-01-19

|quote=When I did the original JavaDoc in the original compiler, even the people close around me pretty soundly criticized it. And it was interesting, because the usual criticism was: a good tech writer could do a lot better job than the JavaDoc does. And the answer is, well, yeah, but how many APIs are actually documented by good tech writers? And how many of them actually update their documentation often enough to be useful?}}</ref>

The <code>@tag</code> syntax of Javadoc has been re-used by other documentation generators, including [[Doxygen]], [[JSDoc]], [https://www.erlang.org/doc/apps/edoc/chapter.html EDoc] and [[HeaderDoc]].

== Design ==