如何在不使用格式的情況下在javadoc中使用「<" and ">」？

如果我在javadoc中編寫<xmlElement>，它不會出現，因爲標籤在格式化文本時有特殊功能。如何在不使用格式的情況下在javadoc中使用「<" and ">」？

如何在javadoc中顯示此字符？

2010-05-24 Tom Brito

相關漂亮了一點，但並不完全是欺騙：http://stackoverflow.com/questions/1782040/does-javadoc-have-an-equivalent-to-cdata – Pops 2010-05-24 17:34:59

111

可以使用<爲<和>爲>。

來源

2010-05-24 17:35:52

你可以使用「代碼」按鈕來設置它的格式'<' – 2010-05-24 17:42:34

或者你可以使用&來逃避＆ – ILMTitan 2010-05-24 21:26:57

@TomBrito雖然這回答了實際問題，但我相信只有當他們被用作尖括號（即成對），這又意味着它們是某些代碼的一部分（例如XML標籤，就像在OP中一樣）。在這種情況下，我相信一個更好的解決方案是將整個XML代碼片段包裝在'{@code ...}'標籤中，就像Etienne Delavennat在他的回答中所建議的那樣。 – 2015-01-22 09:14:39

轉義爲HTML：<和>

來源

2010-05-24 17:30:45 duffymo

所做的一切其他人在這個線程得到downvoted，或者只是我的？ – duffymo 2012-05-04 22:25:10

爲什麼Pavitar Singh的回答被接受，而你的回答只是第三位？ – Majora320 2016-02-27 21:13:37

我喜歡HTML提示。 :) – alexander 2016-04-28 07:28:49

你只需要使用HTML相當於爲尖括號中的一個。 <可以表示爲<或<。下面是從真正的Javadoc抽取的樣本：

 
<pre> 
&lt;complexType> 
    &lt;complexContent> 
    &lt;restriction base="{http://www.w3.org/2001/XMLSchema}anyType"> 
     &lt;sequence> 
     [...]

此爲顯示：

<complexType> 
    <complexContent> 
    <restriction base="{http://www.w3.org/2001/XMLSchema}anyType"> 
     <sequence>

來源

2010-05-24 17:33:18 Pops

最近版本的JavaDoc支持{@literal A <B> C};這會正確輸出內容（在生成的HTML中跳過'<'和'>'）。

見http://download.oracle.com/javase/1.5.0/docs/guide/javadoc/whatsnew-1.5.0.html

來源

2011-05-18 18:59:56

考慮XML是實際的代碼，我相信的Javadoc XML片段是更適合於{@code一個<乙> C ^}標籤而不是{@literal一個<乙> C ^}標籤。

{@code}標記使用固定寬度的字體，使其內容成爲實際代碼。

來源

2015-01-22 08:59:43

我同意。 XML應該用''''''''標籤包裝。它會更自然地顯示（使用固定寬度的字體），並且它在源javadoc中看起來不奇怪，因爲您不必單獨轉義尖括號。 – 2015-01-22 09:11:50

如果你set maven up to use markdown，你可以用反引號包圍它。

`A<B>C`讀取比{@code A<B>C}

來源

2017-02-22 18:06:17 Owen

如何在不使用格式的情況下在javadoc中使用「<" and ">」？

回答

相關問題