To represent keywords
while writing Java Docs should I use the <code>
element or the <tt>
element? Are there specific situations when one should be preferred over the other?
JavaDoc tool is a document generator tool in Java programming language for generating standard documentation in HTML format. It generates API documentation. It parses the declarations ad documentation in a set of source file describing classes, methods, constructors, and fields.
For inline code in Javadocs,you should use {@code your-code-here}
See javadoc - {@code text}
for more details.
Equivalent to
<code>{@literal text}</code>
.Displays text in
code
font without interpreting the text as HTML markup or nested javadoc tags. ..
From the W3C on TT.
HTML Reference
The element is a non-standard element.
HTML5 classifies it as a non-conforming feature.
Examples
No, really, don't use it.
And I think that answers the question. Choice of 2 elements, W3C says do not use one of them.
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With