在 Javadoc 中抑制 <pre> 标签内的换行符

Question

我正在使用 Javadoc 记录 java 方法。有时我会使用 <pre> 标签来制作 fromatting。在 <pre> 标签内，我使用 <em>、<b> 等标签来格式化文本。有时，由于稍后未显示的标签，行会变得很长。因此，我想在稍后不会显示的 Javadoc 中插入一个换行符以提高可读性。以下示例将阐明我正在尝试做的事情：

/**
 * <pre>
 * 
 * <b><em>This</em></b> is <em><b>a</em></b> very <em><b>short</em></b> <em>sentence</em>
 * 
 * </pre>
 *

稍后将在浏览器中显示为

This is a very short sentence

如你所见，标签使得编辑器中的句子很长，所以我想在编辑器中插入一个换行符以提高可读性，但它在浏览器中显示为一行。

/**
 * <pre>
 * 
 * <b><em>This</em></b> is <em><b>a</em></b> <supress this newline>
 * very <em><b>short</em></b> <em>sentence</em>
 * 
 * </pre>

有没有办法抑制 <pre> 标签内的换行符？如果不是，是否可以在不使用 <pre> 标签的情况下获得类似的结果？

Answer 1

这不是一个真正的 javadoc 问题，它是一个一般性的 HTML 问题。

您可以使用 HTML 评论：

/**
 * <pre>
 * 
 * <b><em>This</em></b> is <em><b>a</em></b> <!--
 * -->very <em><b>short</em></b> <em>sentence</em>
 * 
 * </pre>

在 Javadoc 中抑制 <pre> 标签内的换行符

Suppress a newline inside <pre> tags in Javadoc

html

java

javadoc