Javadoc注释中的多行代码示例

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

当前回答

用<pre></pre>标签将多行代码括起来。

2009-02-12 15:56:51

其他回答

至少在Visual Studio Code中，你可以通过将Javadoc注释包装成三反引号来强制它遵守换行符，如下所示:

/** ```markdown
 * This content is rendered in (partial) markdown.
 * 
 * For example, *italic* and **bold** text works, but [links](https://www.google.com) do not.
 * Bonus: it keeps single line-breaks, as seen between this line and the previous.
 ``` */

2019-10-28 14:24:12

用<pre></pre>标签将多行代码括起来。

2009-02-12 15:56:51

从Java 18 (JEP 413)开始，您可以使用@snippet标记:

/**
 * -- ex: looping through List of Map objects --
 * {@snippet :
 * 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"));
 * }
 * }
 *
 * @param query - select statement
 * @return List of Map objects
 */

2021-11-03 16:08:45

<blockquote><pre>…以前和< > {@code……前者将省略泛型中的类型声明，而后者将保留它。

例如: List<MyClass> myObject = null; List myObject = null;List<MyClass> myObject = null;第二种情况

2012-07-19 09:24:47

试着用“pre”代替“code”。HTML中的pre标记将文本标记为预格式化，所有换行符和空格都将在您键入它们时显示。

2009-02-12 15:58:40

Javadoc注释中的多行代码示例

推荐文章

最新文章

标签