在javadoc中打破幾行的長URL

如果我使用從Internet上獲取的一段代碼或資源，我希望在類或函數文檔中指出這一點，並提供一個指向原始源的鏈接。不過，在編寫代碼以提高可讀性時，我還想堅持每行最多80個字符的原則。有沒有一種方法可以將源代碼中的長URL解析爲多行，並且在Eclipse中使用IDE中的javadoc時仍然保持原始地址可用？在可用的情況下，我的意思是點擊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 { 

}

來源

2016-12-09 pnkkr

我不這麼認爲。也許使用鏈接縮短器？在SO，fwiw，你可以使用URL直到問題ID。例如，這個問題在http://stackoverflow.com/questions/41056517。 – yshavit

*「我還想在編寫代碼以提高可讀性時遵循每行最多80個字符的原則」*這是一個原則，而不是一個將您送入監獄違反它的法律。長URL不可讀。如果您使用鏈接縮短器，則鏈接變得完全模糊，即不可讀。那麼，你究竟想要做些什麼？那麼，如果javadoc源代碼與一個不可讀的URL排成一行呢？只需使編譯好的javadoc可讀，就像[philantrovert顯示給你]（http://stackoverflow.com/a/41056619/5221149）。 – Andreas

我知道這不是一個法律，但有時候會遇到這樣的事情，我是一個有點惱人的人，並且很想找到解決方法:)但現在我會解決縮短的鏈接。多謝你們！ – pnkkr

如果你不希望使用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例如，讓你保留原始網址。

來源

2017-07-13 08:01:55 Stuart

相反，你可以使用下面的

@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

來源

2016-12-09 09:00:08 philantrovert

這是一種簡潔的方式來縮短用戶在工具提示中看到的鏈接，但在原始源中鏈接仍然超過了80個字符的限制。 – pnkkr

然後我認爲唯一的解決方案是URL縮短器。 – philantrovert

在javadoc中打破幾行的長URL

回答

相關問題