2010-05-24 9 views
78

यदि मैं एक javadoc में <xmlElement> लिखता हूं, तो ऐसा नहीं होता है, क्योंकि टैग्स को स्वरूपण ग्रंथों पर विशेष कार्य होते हैं।मैं प्रारूपण के बिना javadoc में "<" and ">" का उपयोग कैसे कर सकता हूं?

मैं इस वर्ण को जावडोक में कैसे दिखा सकता हूं?

+4

संबंधित से अच्छे पढ़ता नहीं बल्कि काफी शिकार: http://stackoverflow.com/questions/1782040/does-javadoc-have-an-equivalent-to-cdata – Pops

उत्तर

111

आप के लिए < और &gt;> के लिए &lt; उपयोग कर सकते हैं एक नमूना असली जावाडोक से लिया है। JavaDoc समर्थन {@literal एक < बी > सी} की

+1

आप इसे '<' –

+0

प्रारूपित करने के लिए "कोड" बटन का उपयोग कर सकते हैं या आप & का उपयोग – ILMTitan

+8

@TomBrito से बचने के लिए कर सकते हैं हालांकि यह वास्तविक प्रश्न का उत्तर देता है, मुझे विश्वास है कि संकेतों से बचने की आवश्यकता केवल तभी दिखाई देती है जब वे कोण ब्रैकेट्स (यानी जोड़ों में) के रूप में उपयोग किया जाता है, जो बदले में इंगित करता है कि वे कुछ कोड (जैसे एक्सपी टैग, जैसे ओपी के मामले में) का हिस्सा हैं। इस स्थिति में, मेरा मानना ​​है कि एक बेहतर समाधान पूरे एक्सएमएल स्निपेट को '{@code ...}' टैग में लपेटना है, क्योंकि एटियेन डेलावनेट ने अपने जवाब में सुझाव दिया था। –

13
उन्हें HTML के रूप में पलायन

: &lt; और &gt;

+0

क्या सभी इस धागे में दूसरों को गिरा दिया गया है, या सिर्फ मेरा? – duffymo

+0

पविटर सिंह का जवाब क्यों स्वीकार किया गया, और आपका केवल तीसरा सबसे ऊपर था? – Majora320

+0

मुझे एचटीएमएल संकेत पसंद है। :) – alexander

9

आप केवल कोण कोष्ठक में से एक के लिए HTML बराबर का उपयोग करने की जरूरत है। < को &lt; या &#60; के रूप में दर्शाया जा सकता है।

 
<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> 
26

को ध्यान में रखते एक्सएमएल वास्तविक कोड है, मेरा मानना ​​है कि जावाडोक में XML के टुकड़े बेहतर अनुकूल हैं के बजाय {@code एक < बी > सी} टैग के लिए {@literal एक < बी > सी} टैग ।

{@code} टैग एक निश्चित चौड़ाई फ़ॉन्ट का उपयोग करता है जो इसकी सामग्री को वास्तविक कोड के रूप में स्टैंडआउट करता है।

+1

मैं सहमत हूं। एक्सएमएल को '{@code}' टैग में लपेटा जाना चाहिए। यह अधिक स्वाभाविक रूप से प्रदर्शित किया जाएगा (एक निश्चित चौड़ाई फ़ॉन्ट के साथ), और यह स्रोत जावाडोक में अजीब नहीं लगेगा, क्योंकि आपको कोण ब्रैकेट से अलग से बचने की ज़रूरत नहीं है। –

2

यदि आप set maven up to use markdown, तो आप सिर्फ यह बैकटिक साथ घेर कर सकते हैं।

`A<B>C` थोड़ा {@code A<B>C}

संबंधित मुद्दे