बिना प्रारूपण के मैं javadoc में "<" और ">" का उपयोग कैसे कर सकता हूं?

Question

यदि मैं <xmlElement>एक जावाडॉक में लिखता हूं , तो यह प्रकट नहीं होता है, क्योंकि टैग्स का प्रारूपण ग्रंथों पर विशेष कार्य होता है।

मैं इस चार्ट को एक javadoc में कैसे दिखा सकता हूं?

Comments

संबंधित लेकिन बहुत अधिक नहीं है: stackoverflow.com/questions/1782040/…

— चबूतरे

Answer 1

आप उपयोग कर सकते हैं <के लिए < और >के लिए > ।

Comments

या आप उपयोग कर सकते हैं & amp; भागने के लिए &

— ILMTitan

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

— ज़ोल्टन

&gtया &ltXML प्रारूप में कोण कोष्ठक के साथ बिल्कुल समान अर्थ नहीं है। लेकिन {@code <>}एक सही विकल्प है।

— CinqS

Answer 2

JavaDoc के हाल के संस्करण {@literal A <B> C}; यह सामग्री को सही ढंग से आउटपुट करता है (उत्पन्न HTML में '<' और '>' से बचकर)।

Http://download.oracle.com/javase/1.5.0/docs/guide/javadoc/whatsnew-1.5.0.html देखें

Answer 3

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

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

Comments

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

— ज़ोल्टन

Answer 4

उन्हें HTML के रूप में बच: <और>

Answer 5

आपको केवल कोण कोष्ठक में से एक के लिए HTML समकक्ष का उपयोग करने की आवश्यकता है। <के रूप में या तो किया जा सकता है <या <। यहाँ असली Javadoc से लिया गया एक नमूना है:

<Pre>
& LT; complexType>
  & LT; complexContent>
    & lt; प्रतिबंध आधार = "{http://www.w3.org/2001/XMLSchemaariosanyType">
      & LT; अनुक्रम>
      [...]

यह इस प्रकार प्रदर्शित होता है:

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

Answer 6

यदि आप मार्कडाउन का उपयोग करने के लिए मावेन सेट करते हैं , तो आप इसे बैकटिक्स के साथ घेर सकते हैं।

`A<B>C` से थोड़ा अच्छा पढ़ता है {@code A<B>C}

Answer 7

<Pre> और {@code} का व्यवधान एंगल ब्रैकेट्स और खाली लाइनों को javadocs में बचाता है और व्यापक रूप से उपयोग किया जाता है, उदाहरण के लिए java.util.Stream देखें।

<pre>{@code
   A<B>C

   D<E>F
}</pre>

Answer 8

बस इसे {@code}इस तरह से घेरें:

{@code <xmlElement>}