在javadoc中将长URL断开到几行

时间:2016-12-09 08:53:33

标签: java eclipse formatting javadoc

如果我使用一段代码或资源从互联网上获取我喜欢在课程或功能文档中指出这一点,并提供原始来源的链接。但是,在编写代码以提高可读性时,我还想坚持每行最多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 {

}

3 个答案:

答案 0 :(得分:4)

如果您不想使用网址缩短器,可以使用lastcolumn = ws.Cells(1, ws.Columns.Count).End(xlToLeft).Column lastRow = ws.Cells(ws.Rows.Count, 1).End(xlUp).Row Set range_to_copy = Range(ws.Cells(1, 1), ws.Cells(lastRow, lastcolumn)) 标记围绕您的网址,如下所示:

<pre></pre>

例如,这将满足checkstyle,并让您保留原始网址。

答案 1 :(得分:3)

我发现的另一种解决方案是仅中断行,并确保连续的行完全遵循URL(在其之间没有任何其他字符)。

例如:

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

答案 2 :(得分:2)

相反,您可以使用以下

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

,它将呈现为:

  

另见:       SO Link

来源:javadoc