2009-03-31 16 views
42

मैं javadocs में लिंक कैसे लिखूं?जावाडोक लिंक कैसे लिखें?

वर्तमान में, मैं की तरह कुछ है:

{@link java.lang.Math#sqrt(double) Math.sqrt} 

पाठ Math.sqrt कि java.lang.Math.sqrt(double) एपीआई से लिंक करना चाहिए निर्माण करने के लिए, हालांकि, सभी यह करता है पाठ, कोई लिंक का उत्पादन है।

+0

http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html –

उत्तर

17

अपने कोड के लिए कुछ बाहरी के लिए एक लिंक पाने के लिए आपको -linkoffline विकल्प

जहां -linkoffline विकल्प इस तरह प्रारूप कुछ (कृत्रिम रूप से लिपटे) है का उपयोग की जरूरत है:

-linkoffline http://java.sun.com/javase/6/docs/api/ 
      http://java.sun.com/javase/6/docs/api/ 

यह बताता है JavaDoc टूल जहां JavaDoc के लिंक को ढूंढना है और किस लिंक के लिए उस लिंक का उपयोग करना है। 2 यूआरएल से, यह वास्तविक URL लोड करने के लिए "पैकेज-सूची" में संलग्न कर देगा:

http://java.sun.com/javase/6/docs/api/package-list

जो आपको एक ब्राउज़र में यह लोड करके सत्यापित कर सकते हैं कि JavaDoc URL पर प्रलेखित पैकेजों की सूची को शामिल करता है। यह JavaDoc उपकरण को बताता है कि उन संकुलों में से किसी एक में किसी भी @link संदर्भों को संदर्भित यूआरएल से लिंक करना चाहिए।

+0

आपका सटीक उत्तर मेरे लिए काम नहीं करता है, लेकिन आपने मुझे जो चाहिए वह मुझे दिया। – masher

+2

लिंक विकृत नहीं है - आप लिंक लेबल के रूप में लिंक लेबल के रूप में उपयोग करने के लिए पाठ की एक स्ट्रिंग प्रदान कर सकते हैं @link के दूसरे तर्क के रूप में। – mipadi

+0

@ मिपाडी: ओह! जावा प्रोग्रामिंग के अपने सभी वर्षों में, मैंने इसे कभी नहीं देखा है। मुझे बताने के लिए धन्यवाद। मैं अपना जवाब सही कर दूंगा। – Eddie

-1

This document सहायता की हो सकती है, याद रखें कि @ लिंक के लिए आपको उस दस्तावेज़ के लिए यूआरएल का उपयोग करने की आवश्यकता है जिसे आप लिंक कर रहे हैं।

+0

लिंक मर चुका है। और यही कारण है कि हम स्टैक ओवरफ्लो (या सामान्य रूप से स्टैक एक्सचेंज) पर लिंक पोस्ट नहीं करते हैं। –

+3

@ लिंक यूआरएल के लिए नहीं है! – Alex

20

मेरा जवाब बहुत एडी द्वारा प्रदान की गई है, लेकिन उनके सटीक कोड तो मुझे क्या करना

(जब कि जावा 1.6 के साथ आता है जावाडोक के संस्करण का उपयोग कर कम से कम या) मेरे लिए काम नहीं करता:

 javadoc -linkoffline http://java.sun.com/javase/6/docs/api/ 
          http://java.sun.com/javase/6/docs/api/package-list 
      -public FileName.java

तो जावाडोक शिकायत:

 javadoc: warning - Error fetching URL: 
    http://java.sun.com/javase/6/docs/api/package-list/package-list

हैं, तो दूसरी ओर, मुझे क्या करना:

 javadoc -linkoffline http://java.sun.com/javase/6/docs/api/ 
          http://java.sun.com/javase/6/docs/api/ 
      -public FileName.java

तो यह काम करता है, और मेरे लिंक भर जाती है के रूप में मैं उन्हें होना चाहते हैं।

इसके अतिरिक्त, मेरा लिंक विकृत नहीं है। पाठ {@link java.lang.Math#sqrt(double) Math.sqrt} डिफ़ॉल्ट Math.sqrt(double) के बजाय लिंक टेक्स्ट Math.sqrt उत्पन्न करता है।

+0

मैंने अपना जवाब तय कर दिया। तुम सही हो। – Eddie

+0

पहले संस्करण के लिए (जब आपने यूआरएल में * पैकेज-सूची * शामिल किया था), [javadoc दस्तावेज़ीकरण पृष्ठ] (http: // docs।oracle.com/javase/6/docs/technotes/tools/windows/javadoc.html#linkoffline) पृष्ठ पैरामीटर * packagelistLoc * (उद्धरण) के लिए कहता है: ** * पैकेज-सूची * फ़ाइल नाम शामिल न करें। ** तो यह सब कुछ समझाता है। – informatik01

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