在Javadoc中将长网址中断为几行

Question

如果我使用的是从互联网等获取的代码或资源，我想在类或函数文档中指出这一点，并提供指向原始资源的链接。但是，我在编写代码时也希望坚持每行最多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 {

}

Answer 1

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

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

Answer 2

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

例如：

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