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注释中格式化代码示例的最佳方法是什么?

当前回答

/**
 * <blockquote><pre>
 * {@code
 * public Foo(final Class<?> klass) {
 *     super();
 *     this.klass = klass;
 * }
 * }
 * </pre></blockquote>
 **/

<pre/>用于保存行。 {@code必须有自己的行 <blockquote/>只是用于缩进。

public Foo(final Class<?> klass) {
    super();
    this.klass = klass;
}

用JDK8更新

正确代码的最低要求是<pre/>和{@code}。

/**
 * test.
 *
 * <pre>{@code
 * <T> void test(Class<? super T> type) {
 *     System.out.printf("hello, world\n");
 * }
 * }</pre>
 */

收益率

 <T> void test(Class<? super T> type) {
     System.out.printf("hello, world\n");
 }

可选的括起来<blockquote/>插入缩进。

/**
 * test.
 *
 * <blockquote><pre>{@code
 * <T> void test(Class<? super T> type) {
 *     System.out.printf("hello, world\n");
 * }
 * }</pre></blockquote>
 */

收益率

     <T> void test(Class<? super T> type) {
         System.out.printf("hello, world\n");
     }

插入<p>或用<p>和</p>包围会产生警告。

2014-03-05 10:14:01

其他回答

我附上了带有<pre class="brush: java"></pre>标签的示例代码，并对已发布的javadocs使用SyntaxHighlighter。它不会损害IDE，并使已发布的代码示例更漂亮。

2011-09-07 05:28:50

用<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

使用Java SE 1.6，看起来所有大写的PRE标识符都是在Javadoc中做到这一点的最佳方式:

/**
 * <PRE>
 * insert code as you would anywhere else
 * </PRE>
 */

是最简单的方法。

我从java.awt.Event方法中得到了一个javadoc的例子:

/**
 * <PRE>
 *    int onmask = SHIFT_DOWN_MASK | BUTTON1_DOWN_MASK;
 *    int offmask = CTRL_DOWN_MASK;
 *    if ((event.getModifiersEx() & (onmask | offmask)) == onmask) {
 *        ...
 *    }
 * </PRE>
 */

这将产生与常规代码完全相同的输出，常规代码间距和新行不变。

2012-06-07 15:20:54

我刚刚在这里阅读了Javadoc 1.5参考，只有<和>的代码必须包含在{@code…}中。这里有一个简单的例子:

 /** 
 * Bla bla bla, for example:
 *
 * <pre>
 * void X() {
 *    List{@code <String>} a = ...;
 *    ...
 * }
 * </pre>
 *
 * @param ...
 * @return ...
 */
 .... your code then goes here ...

2017-03-10 10:43:08

Javadoc注释中的多行代码示例

推荐文章

最新文章

标签