在javadoc中将长URL断开到几行

如果我正在使用从etc internet获取的一段代码或资源，我喜欢在类或函数文档中指出这一点，并提供指向原始源代码的链接。然而，为了更好的可读性，我还希望在编写代码时坚持每行最多80个字符的原则。在像Eclipse这样的IDE中使用javadoc时，有没有一种方法可以将源代码中的长URL解析为多行，并保持原始地址可用？我的意思是，单击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 {

}

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

---

相反，您可以使用以下命令

@see <a href = "https://stackoverflow.com/questions/and-huge-amouts-of-URL-address-which-does-not-fit-to-80-chars"> SO Link </a>

@参见

并将其呈现为：

另请参见：

---

来源：

如果您不想使用URL缩写器，您可以用

标记围绕您的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。

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

例如：

/**
*链接到
*/

我不这么认为。也许可以使用链接缩短器？因此，fwiw，您可以使用问题id之前的URL。例如，这个问题位于。“我还希望在编写代码时遵守每行最多80个字符的原则，以提高可读性。”这是一项原则，而不是一项会因违反该原则而将您送进监狱的法律。长URL不可读。如果使用链接缩短器，链接将变得完全模糊，即不可读。那么，你到底想让什么更具可读性呢？那么，如果javadoc源代码中有一行很长的URL，而该URL无论如何都不可读呢？只是让编译后的javadoc可读，比如。我知道这不是一条定律，但有时人们会遇到这样的事情，我是那种会感到恼火并想找到解决办法的人：）但我现在就满足于缩短链接。谢谢大家！如果您的团队使用Checkstyle之类的工具来强制执行代码标准（如行长度），那么这就变得非常重要。由于无法拆分该行，因此需要一个覆盖注释或配置来处理该警告。在本例中，我将

添加到

lineLength

Checkstyle配置中。这是缩短用户在工具提示中看到的链接的好方法，但在原始源代码中，链接仍然超过了80个字符的限制。然后我认为唯一的解决方案是URL缩短器。这是最好的答案。它也适用于

@请参见

。我看到的唯一缺点是第三行缺少的“*”看起来有点难看。话虽如此，我尝试了公认的答案（使用

标记），似乎您需要删除“*”，URL才能正常工作。此外，作为已接受答案的副作用，

标记可能会影响Javadoc格式，而此答案并非如此。