12

如何格式化 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; }

在此处输入图像描述

屏幕截图来自 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
 */

在此处输入图像描述

4

2 回答 2

11

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

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

/**
 * 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 截图

于 2013-08-09T07:08:43.380 回答
8

采用:

/**
 * <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; }
于 2013-08-05T09:34:23.093 回答