आप javadoc में @ चरित्र से कैसे बच सकते हैं?


180

मैं @javadoc में प्रतीक से कैसे बच सकता हूं ? मैं इसे एक {@code}टैग के अंदर उपयोग करने की कोशिश कर रहा हूं , जो कि <pre>टैग के अंदर है ।

मैंने पहले ही html एस्केप &#64;सीक्वेंस की कोशिश की थी, लेकिन यह काम नहीं किया।


अब मैंने @ {कोड} ब्लॉक के अंदर कुछ इंडेंटेशन को समायोजित करने के बाद इसे प्रदर्शित करना शुरू कर दिया है! यदि यह मायने रखता है तो यह ग्रहण में था।
JayL

मुझे अभी भी यह काम नहीं मिल रहा है
नील

जवाबों:


267

{@literal}Javadoc टैग का उपयोग करें :

/**
 * This is an "at" symbol: {@literal @}
 */

इसके लिए javadoc पढ़ेगा:

This is an "at" symbol: @

बेशक, यह किसी भी वर्ण के लिए काम करेगा , और किसी भी "विशेष" वर्ण को प्रदर्शित करने का "आधिकारिक रूप से समर्थित" तरीका है।

यह सबसे अधिक स्पष्ट है - आपको वर्ण के हेक्स कोड को जानने की आवश्यकता नहीं है, और आप जो टाइप कर चुके हैं उसे पढ़ सकते हैं!


1
आप }प्रतीक से कैसे बचेंगे ?
ADTC

1
@ADTC आप नहीं कर सकते। आपको क्यों चाहिए होगा? }html में कोई विशेष अर्थ नहीं है।
बोहेमियन

इसलिए मुझे लगता है कि आप इसे केवल दो literalटैग में विभाजित कर सकते हैं ।
ADTC

23
मुझे आश्चर्य है कि यह स्वीकार किया जाता है और इतना वोट दिया जाता है। प्रश्न का संकलन : {@code} टैग के अंदर । {@Literal} सिर्फ {@code} टैग के अंदर काम नहीं करता है।
डैनियल सी। सोबरल

6
छोड़ना {और बस का उपयोग कर @literal @एक के अंदर काम करता है {@code}टैग।
ब्रैड ट्यूरेक

55

बस इसे HTML इकाई के रूप में लिखें:

&#064;

दस्तावेज़ से " javadoc - जावा एपीआई प्रलेखन जेनरेटर "

यदि आप @ वर्ण के साथ एक पंक्ति शुरू करना चाहते हैं और इसकी व्याख्या नहीं की गई है, तो HTML इकाई @ का उपयोग करें।

इसका तात्पर्य है कि आप किसी भी चरित्र के लिए HTML संस्थाओं का उपयोग कर सकते हैं जिन्हें आपको भागने की आवश्यकता होगी, और वास्तव में आप कर सकते हैं:

टेक्स्ट को HTML संस्थाओं और HTML टैग्स के साथ HTML में लिखा जाना चाहिए। आप अपने ब्राउज़र का समर्थन करता है जो भी HTML के संस्करण का उपयोग कर सकते हैं। मानक डॉकलेट कैस्केडिंग स्टाइल शीट और फ्रेम के समावेश के साथ HTML 3.2-अनुरूप कोड कहीं और (प्रलेखन टिप्पणियों के बाहर) उत्पन्न करता है। फ्रेम सेट के कारण उत्पन्न फ़ाइलों के लिए HTML 4.0 को प्राथमिकता दी जाती है।

उदाहरण के लिए, प्रतीक से कम (<) और प्रतीक (>) से अधिक के लिए इकाइयां के रूप में &lt;और लिखा जाना चाहिए &gt;। इसी तरह, एम्परसेंड (&) के रूप में लिखा जाना चाहिए &amp;


यह शाब्दिक अभिव्यक्ति से बेहतर काम करता है जब किसी स्थान का अनुसरण नहीं किया जाता है (उदाहरण के लिए जब एनोटेशन होता है)
Bludwarf

8

मेरा समाधान है

/**
 * Mapper Test Helper.
 *
 * add the following annotations above the class
 * <pre>{@code
 * // junit5
 * @literal @ExtendWith(SpringExtension.class)
 * // junit4
 * @literal @RunWith(SpringRunner.class)
 * }</pre>
 */

2

आपको सामान्य विचार मिला, अष्ट प्रतिनिधित्व का उपयोग करने का प्रयास करें: &#064;


6
यह अष्टाध्यायी नहीं है।
जॉय

@हेक्साडेसिमल में कोडपॉइंट 0x40 है, जो दशमलव में 64 है
बिनक सैलरीमैन
हमारी साइट का प्रयोग करके, आप स्वीकार करते हैं कि आपने हमारी Cookie Policy और निजता नीति को पढ़ और समझा लिया है।
Licensed under cc by-sa 3.0 with attribution required.