在 javadoc 中将长 URL 拆分为多行

formatting eclipse java javadoc

2022-09-04 20:05:37

如果我使用一段代码或从互联网上获取的资源，我喜欢在类或函数文档中指出这一点，并提供指向原始源代码的链接。但是，在编写代码时，我也想坚持每行最多80个字符的原则，以提高可读性。有没有办法将源代码中的长URL解析为多行，并且在像Eclipse这样的IDE中使用javadoc时仍然保持原始地址的可用性？对于可用，我的意思是单击javadoc工具提示中的URL会打开正确的页面。

例如，如何设置以下内容的格式：

/**
 * Class to do some cool stuff
 * Original source: 
 * http://stackoverflow.com/questions/and-huge-amouts-of-URL-address-which-does-not-fit-to-80-chars
 */
public class ExampleClass {

}

答案 1

如果您不想使用URL缩短器，则可以用标签将URL括起来，如下所示：<pre></pre>

/**
 * Class to do some cool stuff
 * Original source: 
 * <pre>
 * See <a href="http://stackoverflow.com/questions/
   and-huge-amouts-of-URL-address-which-does-not-fit-to-80-chars">NameOfyourLink</a>
 * </pre>
 */

例如，这将满足checkstyle，并允许您保留原始URL。

答案 2

我发现的另一个解决方案是断开行，并确保连续的行完全遵循URL（两者之间没有任何其他字符）。

例如：

/**
* Link to <a href="https://developer.android.com/reference/android/app/Service#
startForeground(int,%20android.app.Notification)">startForeground(..)</a>
*/