Javadocs和多行描述?

时间:2012-04-18 12:34:06

标签: java documentation javadoc

我遇到了javadocs的问题。它似乎既有用又极其愚蠢! 我正在尝试为类编写多行描述:

/**
 * this is my class, there are many like it, but this one is mine!
 * 
 * blah blah blah
 *       - blah blah
 *       - blah blah
*/

但是当使用该类时,描述显示为单行blob! 请告诉我制作它的人比这更聪明,并且有一种方法可以让javadocs显示多行描述。

谢谢。

3 个答案:

答案 0 :(得分:13)

插入HTML标记,例如:

/**
 * <p>this is my class, there are many like it, but this one is mine!</p>
 * 
 * <p>blah blah blah<p>
 * <ul>
 *  <li>blah blah</li>
 *  <li>blah blah</li>
 * </ul>
*/

答案 1 :(得分:1)

Javadoc的工作方式与HTML类似。试试像

这样的东西
-blah blah <br /> -blah blah

答案 2 :(得分:1)

您可以在javadoc中使用html标记。例如,您可以使用以下内容:

/**
 * this is my class, there are many like it, but this one is mine!<br/>
 * 
 * blah blah blah
 *     <ul>  <li>blah blah</li>
 *       <li> blah blah</li>
 *     </ul>
*/