我有一个小代码示例，我想在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>与{@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)，它被正确呈现。
换行符需要<pre></pre>标签，{@code…}用于泛型。但是不允许将开始大括号与<generic>标记放在同一行上，因为这样所有内容将再次显示在一行上。
显示在一行上:
* ..
* <pre>
* {@code
* public List<Object> getObjects() {
* return objects;
* }
* </pre>
* ..
显示带有换行符:
* ..
* <pre>
* {@code
* public List<Object> getObjects()
* {
* return objects;
* }
* </pre>
* ..
另一件奇怪的事情是，当你粘贴{@code的右大括号时，它会显示:
* ..
* <pre>
* {@code
* public List<Object> getObjects()
* {
* return objects;
* }
* }
* </pre>
* ..
输出:
public List<Object> getObjects()
{
return objects;
}
}
在javadoc注释中包含特定的代码示例时，我遇到了很大的困难。我想分享这个。
请注意以下事项:
使用旧的<code> -标签来防止花括号被解释
new {@code…} -标签来获取输出中包含的泛型
@Override中的@符号通过"{@literal @}Override"转义，因为javadoc生成器在那里“倾斜”，因为@直接放在左花括号后面
在{@code和{@literal前面删除一个空格，以补偿内部空格并保持对齐
javadoc代码:
/** this methods adds a specific translator from one type to another type. `
* i.e.
* <pre>
* <code>new BeanTranslator.Builder()
* .translate(
* new{@code Translator<String, Integer>}(String.class, Integer.class){
* {@literal @}Override
* public Integer translate(String instance) {
* return Integer.valueOf(instance);
* }})
* .build();
* </code>
* </pre>
* @param translator
*/
被打印为
new BeanTranslator.Builder()
.translate(
new Translator<String, Integer>(String.class, Integer.class){
@Override
public Integer translate(String instance) {
return Integer.valueOf(instance);
}})
.build();
除了前面提到的<pre>标记之外，你还应该使用@code JavaDoc注释，这将使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中可用的标记描述的完整列表。
