java - 禁止 Javadoc 中 标签内的换行符

Question

我正在使用 Javadoc 记录 java 方法。有时我使用<pre>用于格式化的标签。里面<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>