如何格式化javadoc注释中的标题?

时间:2013-08-05 09:29:20

标签: java javadoc

如何在javadoc评论中设置标题格式,使其与@param@return@throws的格式相匹配。我询问如何定义我自己的关键词,而不是如何使用与他们相似的粗体字标题。

我尝试过<h1></h1>,但在Eclipse的Javadoc视图中看起来很糟糕,特别是尺寸要大得多。有替代方案还是<h1></h1>要走的路?

/**
 * foo
 *
 * @param x foo
 * @return foo
 * @throws foo
 */
public int foo(int x) { return x; }

enter image description here

截图来自Eclipse。

更新

我不认为<strong>就足够了,因为它不会添加换行符:

/**
 * Introdcution
 * 
 * <strong>Heading</strong>There is no line break.
 * <strong>Heading</strong>There is no line break.
 *
 * @param x foo
 * @return foo
 * @throws foo
 */

enter image description here

2 个答案:

答案 0 :(得分:9)

只需查看生成的JAVA API的Java Doc,例如SimpleDateFormat.parse(查看HTML源代码)。

他们使用html描述列表进行格式化,使用strong CSS类来格式化术语。所以这样做:

/**
 * Introdcution
 * 
 * <dl>
 * <dt><span class="strong">Heading 1</span></dt><dd>There is a line break.</dd>
 * <dt><span class="strong">Heading 2</span></dt><dd>There is a line break.</dd>
 * </dl>
 *
 * @param x foo
 * @return foo
 * @throws foo
 */

看起来像这样:

JavaDoc screenshot

答案 1 :(得分:5)

使用:

/**
 * <strong>Heading</strong>There is no line break.
 * <br /> <strong>Heading</strong>There is no line break.
 *
 * @param x foo
 * @return foo
 * @throws foo
 */
public int foo(int x) { return x; }