Menu
How to put a sample XML code in Javadoc? The XML code includes angle brackets which I do not want to be processed.
I tried combinations of PRE and code but it didn't work.
381
Place the caret at the declaration in the editor, press Alt+Enter , and select Add Javadoc from the list.
Before using JavaDoc tool, you must include JavaDoc comments /**……………….. */ providing information about classes, methods, and constructors, etc. For creating a good and understandable document API for any java file you must write better comments for every class, method, constructor.
We can use the @see and @link tag multiple times in a class, package, or method. The @see tag declares references that point to an external link, class, or method. The @link tag can also be used multiple times for declaring inline links or in contrast with other block tags.
There are no real restrictions on the use of HTML in Javadoc comments. The Javadoc documentation states: Comments are written in HTML - The text must be written in HTML, in that they should use HTML entities and can use HTML tags.
You can use @code javadoc tag. Take a look to this post, wich contains some examples. Hope it helps
/**
* To use this class use this XML
* <pre>
* {@code
* <xml>
* <parameter>foo</parameter>
* <value>bar</value>
* </xml>
* }
* </pre>
*/
You have to use HTML/XML encoding like < for < and > for >.
If you use Eclipse, there is a Javadoc view that shows you a preview.
37
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
