将样例XML代码放入Javadoc文档

Question

如何在Javadoc中插入示例XML代码？XML代码包含不想被处理的尖括号。

我尝试过使用PRE和code标签的组合，但没有成功。

- Suzan Cioc

Answer 1

您可以使用@code javadoc标签。请参阅此帖子，其中包含一些示例。希望它有所帮助。

/**
 * To use this class use this XML   
 * <pre>
 * {@code
 * <xml>
 *   <parameter>foo</parameter>
 *   <value>bar</value>
 * </xml>
 * }
 * </pre>
 */

- troig

Answer 2

在使用 < 和 > 时，必须使用 HTML/XML 编码，例如使用 < 表示 < ，使用 > 表示 >。

如果你使用 Eclipse，可以使用 Javadoc 视图预览。

- Andy