Javadoc注释中的多行代码示例

Question

我有一个小的代码示例，我想在方法的Javadoc注释中包括它。

/**
 * -- ex: looping through List of Map objects --
 * <code>
 * for (int i = 0; i < list.size(); i++) {
 *      Map map = (Map)list.get(i);
 *      System.out.println(map.get("wordID"));
 *      System.out.println(map.get("word"));
 * }
 * </code>
 * 
 * @param query - select statement
 * @return List of Map objects
 */

问题是代码示例显示在Javadoc中，没有换行符，很难阅读。

-- ex: looping through List of Map objects -- for (int i = 0; i list.size(); i++) { Map map = (Map)list.get(i); System.out.println(map.get("wordID")); System.out.println(map.get("word")); } 
Parameters
query - - select statement 
Returns:
List of Map objects

我猜我认为代码标签可以处理换行符是错误的。格式化Javadoc注释中的代码示例的最佳方法是什么？

Answer 1

除了已经提到的<pre>标签之外，您还应该使用@codeJavaDoc注释，当涉及到HTML实体问题（尤其是泛型）时，这将使工作变得更加轻松，例如：

* <pre>
* {@code
* Set<String> s;
* System.out.println(s);
* }
* </pre>

将给出正确的HTML输出：

Set<String> s;
System.out.println(s);

省略该@code块（或使用<code>标签）将导致如下所示的HTML：

Set s;
System.out.println(s);