我有一个小代码示例，我想在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注释中格式化代码示例的最佳方法是什么?
java源代码中有很多这样的好例子。下面是"String.java"头部的一个例子:
....
* is equivalent to:
* <p><blockquote><pre>
* char data[] = {'a', 'b', 'c'};
* String str = new String(data);
* </pre></blockquote><p>
* Here are some more examples of how strings can be used:
* <p><blockquote><pre>
* System.out.println("abc");
* String cde = "cde";
* System.out.println("abc" + cde);
* String c = "abc".substring(2,3);
* String d = cde.substring(1, 2);
* </pre></blockquote>
...
这是我的意见。
正如其他答案已经说明的那样，您应该将<pre> </pre>与{@code}结合使用。
使用pre和{@code}
包装你的代码在<pre>和</pre>防止你的代码崩溃到一行;
将代码包装在{@code}中可以防止<、>和中间的所有内容消失。当代码包含泛型或lambda表达式时，这尤其有用。
注释的问题
当代码块包含注释时，就会出现问题。这可能是因为当@符号出现在Javadoc行的开头时，它被认为是一个类似于@param或@return的Javadoc标记。例如，这段代码可能被错误地解析:
/**
* Example usage:
*
* <pre>{@code
* @Override
* public void someOverriddenMethod() {
以上代码将完全消失在我的情况下。
要解决这个问题，行不能以@符号开头:
/**
* Example usage:
*
* <pre>{@code @Override
* public int someMethod() {
* return 13 + 37;
* }
* }</pre>
*/
注意，@code和@Override之间有两个空格，以保持内容与下一行对齐。在我的例子中(使用Apache Netbeans)，它被正确呈现。
