Javadoc 注释中的多行代码示例

小编典典

Javadoc 注释中的多行代码示例

all

我有一个小代码示例，我想将其包含在方法的 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 注释中格式化代码示例的最佳方式是什么？

阅读 124

2022-03-08

共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);

作为参考，可以在此处找到
Java SE 8 中可用的标记描述的完整列表。

2022-03-08