<s>
Javadoc	B-Language
(	O
originally	O
cased	O
JavaDoc	B-Language
)	O
is	O
a	O
documentation	B-Protocol
generator	I-Protocol
created	O
by	O
Sun	O
Microsystems	O
for	O
the	O
Java	B-Language
language	I-Language
(	O
now	O
owned	O
by	O
Oracle	B-Application
Corporation	I-Application
)	O
for	O
generating	O
API	B-Application
documentation	I-Application
in	O
HTML	B-Language
format	O
from	O
Java	B-Language
source	I-Language
code	I-Language
.	O
</s>
<s>
The	O
HTML	B-Language
format	O
is	O
used	O
for	O
adding	O
the	O
convenience	O
of	O
being	O
able	O
to	O
hyperlink	O
related	O
documents	O
together	O
.	O
</s>
<s>
The	O
"	O
doc	B-Language
comments	I-Language
"	O
format	O
used	O
by	O
Javadoc	B-Language
is	O
the	O
de	O
facto	O
industry	O
standard	O
for	O
documenting	O
Java	B-Language
classes	O
.	O
</s>
<s>
Some	O
IDEs	O
,	O
like	O
IntelliJ	B-Language
IDEA	I-Language
,	O
NetBeans	B-Application
and	O
Eclipse	B-Application
,	O
automatically	O
generate	O
Javadoc	B-Language
templates	O
.	O
</s>
<s>
Many	O
file	O
editors	O
assist	O
the	O
user	O
in	O
producing	O
Javadoc	B-Language
source	O
and	O
use	O
the	O
Javadoc	B-Language
info	O
as	O
internal	O
references	O
for	O
the	O
programmer	O
.	O
</s>
<s>
Javadoc	B-Language
also	O
provides	O
an	O
API	B-General_Concept
for	O
creating	O
doclets	O
and	O
taglets	O
,	O
which	O
allows	O
users	O
to	O
analyze	O
the	O
structure	O
of	O
a	O
Java	B-Language
application	O
.	O
</s>
<s>
This	O
is	O
how	O
JDiff	O
can	O
generate	O
reports	O
of	O
what	O
changed	O
between	O
two	O
versions	O
of	O
an	O
API	B-General_Concept
.	O
</s>
<s>
Javadoc	B-Language
does	O
not	O
affect	O
performance	O
in	O
Java	B-Language
as	O
all	O
comments	O
are	O
removed	O
at	O
compilation	O
time	O
.	O
</s>
<s>
Writing	O
comments	O
and	O
Javadoc	B-Language
is	O
for	O
better	O
understanding	O
the	O
code	O
and	O
thus	O
better	O
maintaining	O
it	O
.	O
</s>
<s>
Javadoc	B-Language
was	O
an	O
early	O
Java	B-Language
language	I-Language
documentation	B-Protocol
generator	I-Protocol
.	O
</s>
<s>
Prior	O
to	O
the	O
use	O
of	O
documentation	B-Protocol
generators	I-Protocol
it	O
was	O
customary	O
to	O
use	O
technical	O
writers	O
who	O
would	O
typically	O
write	O
only	O
standalone	O
documentation	O
for	O
the	O
software	O
,	O
but	O
it	O
was	O
much	O
harder	O
to	O
keep	O
this	O
documentation	O
in	O
sync	O
with	O
the	O
software	O
itself	O
.	O
</s>
<s>
Javadoc	B-Language
has	O
been	O
used	O
by	O
Java	B-Language
since	O
the	O
first	O
release	O
,	O
and	O
is	O
usually	O
updated	O
upon	O
every	O
new	O
release	O
of	O
the	O
Java	B-Language
Development	I-Language
Kit	I-Language
.	O
</s>
<s>
The	O
@field	O
syntax	O
of	O
Javadoc	B-Language
has	O
been	O
emulated	O
by	O
documentation	O
systems	O
for	O
other	O
languages	O
,	O
including	O
the	O
cross-language	O
Doxygen	B-Language
,	O
the	O
JSDoc	B-Language
system	O
for	O
JavaScript	O
,	O
and	O
Apple	O
's	O
HeaderDoc	B-Protocol
.	O
</s>
<s>
A	O
Javadoc	B-Language
comment	O
is	O
set	O
off	O
from	O
code	O
by	O
standard	O
multi-line	O
comment	O
tags	O
/	O
*	O
and	O
*	O
/	O
.	O
</s>
<s>
This	O
is	O
because	O
Javadoc	B-Language
reads	O
each	O
variable	O
and	O
places	O
them	O
separately	O
to	O
the	O
generated	O
HTML	B-Language
page	O
with	O
the	O
same	O
documentation	O
comment	O
that	O
is	O
copied	O
for	O
all	O
fields	O
.	O
</s>
<s>
Some	O
of	O
the	O
available	O
Javadoc	B-Language
tags	O
are	O
listed	O
in	O
the	O
table	O
below	O
:	O
</s>
<s>
The	O
enclosed	O
text	O
is	O
interpreted	O
as	O
not	O
containing	O
HTML	B-Language
markup	O
or	O
nested	O
javadoc	B-Language
tags	O
.	O
</s>
<s>
An	O
example	O
of	O
Javadoc	B-Language
to	O
document	O
a	O
method	O
follows	O
.	O
</s>
<s>
Doclet	O
programs	O
work	O
with	O
the	O
Javadoc	B-Language
tool	O
to	O
generate	O
documentation	O
from	O
code	O
written	O
in	O
Java	B-Language
.	O
</s>
<s>
Doclets	O
are	O
written	O
in	O
the	O
Java	B-Language
programming	I-Language
language	I-Language
and	O
use	O
the	O
to	O
:	O
</s>
<s>
The	O
included	O
with	O
Javadoc	B-Language
generates	O
API	B-Application
documentation	I-Application
as	O
frame-based	O
HTML	B-Language
files	I-Language
.	O
</s>
