【问题标题】:Suppress a newline inside <pre> tags in Javadoc在 Javadoc 中抑制 <pre> 标记内的换行符
【发布时间】:2016-08-23 22:36:27
【问题描述】:

我正在使用 Javadoc 记录一个 java 方法。有时我会使用&lt;pre&gt; 标签来标记。在&lt;pre&gt; 标签内,我使用&lt;em&gt;&lt;b&gt; 等标签来格式化文本。有时,由于稍后不显示的标签,行会变得很长。因此,我想在 Javadoc 中插入一个换行符以提高可读性,稍后不会显示。以下示例将阐明我要做什么:

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

这稍后会在浏览器中显示为

这个一个非常 句子

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

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

有没有办法在&lt;pre&gt; 标签中抑制换行符?如果不行,不使用&lt;pre&gt;标签也能达到类似的效果吗?

【问题讨论】:

  • 你在这里找错树了。 &lt;pre&gt; 用于代码,以及您希望按原样格式化的任何其他内容。你的问题体现了一个矛盾。
  • @EJP 请再次阅读问题的最后一部分。我明确表示我愿意使用另一种方法来实现我的目标。简单地说“这不是&lt;pre&gt; 的用途”至少没有帮助。

标签: java html javadoc


【解决方案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>

【讨论】:

  • 谢谢,这产生了我想要的结果。
猜你喜欢
  • 1970-01-01
  • 2016-11-24
  • 1970-01-01
  • 2017-12-14
  • 1970-01-01
  • 2021-09-06
  • 2010-12-03
  • 1970-01-01
  • 1970-01-01
相关资源
最近更新 更多