जावदोक में एक बाहरी URL से लिंक करना?

Question

कुछ इस तरह:

/**
 * See {@linktourl http://google.com}
 */

Answer 1

यह एक "देखें भी" शीर्षक बनाता है, जिसमें लिंक है:

/**
 * @see <a href="http://google.com">http://google.com</a>
 */

के रूप में प्रस्तुत करना होगा:

इसे भी देखें:
           http://google.com

जबकि यह:

/**
 * See <a href="http://google.com">http://google.com</a>
 */

इन-लाइन लिंक बनाएगा:

Http://google.com देखें

Comments

अगर कोई रुचि है, यह देखने के बाद से मैं सिर्फ था अप करने के लिए: के अनुसार जावाडोक कल्पना@see टैग आता है के बाद@param / @returnटैग और से पहले@since / @serial/ @deprecatedटैग।

— फ्राइडेरब्लुमेले

सिर्फ मामले में, Intellij 13 इस टैग का समर्थन नहीं करता है। यह इन-लाइन लिंक का समर्थन करता है। क्या टैग किसी तरह से हटा दिया गया है?

— टिमो

मैं सुझाव देता हूं कि <a href="http://google.com" target="_top">http://google.com</a>. लक्ष्य = "_ शीर्ष" जोड़ने का कारण यह है कि उत्पन्न जेवाडॉक HTML फ़ाइलों में से कुछ फ़्रेम का उपयोग करते हैं, और आप शायद चाहते हैं कि नेविगेशन केवल वर्तमान फ़्रेम के बजाय पूरे पृष्ठ को प्रभावित करे।

— एंटनी

यदि आपको "चेतावनी - टैग \ @ सीएस: लापता अंतिम '>": जैसी चेतावनी मिलती है, तो सुनिश्चित करें कि आपके पास एक ही \ _ \ _ निर्देश में दो हाइपरलिंक नहीं हैं। इसके बजाय, \ @ प्रति प्रति एक लिंक का उपयोग करें।

— ट्रैविस स्पेंसर

javadoc का URL लिंक जोड़ना इतना जटिल क्यों है? किसने सोचा था कि HTML एक अच्छा विचार था ... / फेसप्लम

— किसी

Answer 2

जावदोक युक्ति से लिया गया

@see <a href="URL#value">label</a>: द्वारा परिभाषित के रूप में एक कड़ी जोड़ता है URL#value। URL#valueएक रिश्तेदार या निरपेक्ष URL है। Javadoc टूल <इसे पहले चरित्र के रूप में कम-से-कम प्रतीक ( ) की तलाश करके अन्य मामलों से अलग करता है ।

उदाहरण के लिए : @see <a href="http://www.google.com">Google</a>

Comments

अजीब; मैं कसम खाता हूँ मैं केवल backticks में जोड़ा; मुझे नहीं पता कि उदाहरण कहां गया ...

— स्टोबोर

मुझे लगता है कि हमें किसी प्रकार की समवर्ती संपादन समस्या थी। मैं उन्हें भी अंदर डाल रहा था।

— एरोन

काफी उचित। आप अपने ब्लॉकचेन की पहली पंक्ति में बैकटिक्स को याद कर रहे हैं, हालांकि ....

— स्टोबोर

@ उसे जरूरत नहीं है। Javadocs को html टैग के साथ स्वरूपित किया जा सकता है, इसलिए यह केवल "a" टैग आवश्यक है।

— गेब्रियल लामास

@GabrielLlamas सच है, लेकिन मूल प्रश्न यह है कि इसका उपयोग कैसे किया जा रहा है। यह जानना उपयोगी है कि यह विशेष रूप से एक देखने के क्षेत्र में भी काम करता है , जो कि बहुत सारे लोग इसे चाहते हैं।

— आयनोकॉस्ट ब्रिघम

Answer 3

Javadocs बाहरी लिंक के लिए कोई विशेष उपकरण प्रदान नहीं करते हैं, इसलिए आपको बस मानक html का उपयोग करना चाहिए:

See <a href="http://groversmill.com/">Grover's Mill</a> for a history of the
Martian invasion.

या

@see <a href="http://groversmill.com/">Grover's Mill</a> for a history of 
the Martian invasion.

उपयोग न करें {@link ...}या {@linkplain ...}क्योंकि ये अन्य वर्गों और विधियों के javadocs के लिंक के लिए हैं।

Answer 4

जैसे ए-एलिमेंट के साथ HTML लिंक का उपयोग करें

<a href="URL#value">label</a>

Comments

सही उत्तर को फिर से पोस्ट किया क्योंकि यह अन्य टिप्पणियों से उभरा। यह पूरे धागे की तुलना में पढ़ने में तेज होगा।

— डॉ। मैक्स वोल्केल

Answer 5

ओरेकल साइट से एक स्पष्ट जवाब खोजने के लिए मुश्किल है। निम्नलिखित में से है javax.ws.rs.core.HttpHeaders.java:

/**
 * See {@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1">HTTP/1.1 documentation</a>}.
 */
public static final String ACCEPT = "Accept";

/**
 * See {@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.2">HTTP/1.1 documentation</a>}.
 */
public static final String ACCEPT_CHARSET = "Accept-Charset";

Comments

<a>HTML टैग को लपेटने का क्या महत्व है {@link ...}?

— पैट्रिक एम

यह शायद एक गलती है क्योंकि javadoc प्रलेखन इस रूप का उल्लेख नहीं करता है, इसमें एक कच्चे से फर्क नहीं पड़ता है <a>।

— डिडिएर एल

यहां {@link xxx} सही नहीं है। {@link xxx} आपके स्रोत कोड में अन्य वर्गों और विधियों को जोड़ने के लिए है। यहां अनावश्यक है। बाकी यह ठीक है।

— मिगेलमुनोज

जावा 8 मानकों (डॉक्लिंट ऑन) द्वारा इस निर्माण की अनुमति नहीं है।

— Stepan Vavra

यह सादा गलत है। संदर्भ और प्रलेखन के अनुसार सही उपयोग है{@link package.class#member label}

— दीनी