首页
学习
活动
专区
工具
TVP
发布
社区首页 >问答首页 >Javadoc注释中的多行代码示例?

Javadoc注释中的多行代码示例?

提问于 2017-12-19 14:40:34
回答 2关注 0查看 1.6K

我想在一个方法的Javadoc注释中包含一个小代码示例。

代码语言:txt
复制
/**
代码语言:txt
复制
 * -- ex: looping through List of Map objects --
代码语言:txt
复制
 * <code>
代码语言:txt
复制
 * for (int i = 0; i < list.size(); i++) {
代码语言:txt
复制
 *      Map map = (Map)list.get(i);
代码语言:txt
复制
 *      System.out.println(map.get("wordID"));
代码语言:txt
复制
 *      System.out.println(map.get("word"));
代码语言:txt
复制
 * }
代码语言:txt
复制
 * </code>
代码语言:txt
复制
 * 
代码语言:txt
复制
 * @param query - select statement
代码语言:txt
复制
 * @return List of Map objects
代码语言:txt
复制
 */

问题是在Javadoc中显示的代码示例中没有换行符使其难以阅读。

代码语言:txt
复制
-- 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")); } 
代码语言:txt
复制
Parameters
代码语言:txt
复制
query - - select statement 
代码语言:txt
复制
Returns:
代码语言:txt
复制
List of Map objects 

我想我错了,假设代码标签将处理换行符。在Javadoc注释中设置代码示例的最佳方式是什么?

回答

和开发者交流更多问题细节吧,去 写回答
相关文章

相似问题

相关问答用户
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档