जावाडोक @see या {@link}?

Question

क्या कोई मुझे जावाडोक @see और {@link} के बीच अंतर बता सकता है?

या फिर, उनमें से किस का उपयोग करना है?

Answer 1

official guidelines इस पर स्पष्ट है।

कार्यात्मक अंतर हैं:

• {@link} एक इनलाइन कड़ी है और रखा जा सकता है जहाँ भी आप
• @see तरह अपने स्वयं के अनुभाग

बनाता है मेरी राय में, {@link} सबसे अच्छा है जब प्रयोग किया जाता है आप सचमुच अपने विवरण में कक्षा, फ़ील्ड, कन्स्ट्रक्टर या विधि का नाम उपयोग करते हैं। उपयोगकर्ता जो आपने लिंक किया है उसके जावडोक पर क्लिक करने में सक्षम होंगे।

2 मामलों में @see एनोटेशन का उपयोग करें:

• कुछ बहुत ही प्रासंगिक है, लेकिन विवरण में उल्लेख नहीं।
• मैं विवरण में एक ही चीज़ को कई बार संदर्भित करता हूं, और इसका उपयोग कई लिंक के प्रतिस्थापन के रूप में किया जाता है।

मैंने मानक पुस्तकालय में विभिन्न प्रकार की चीजों के लिए यादृच्छिक रूप से दस्तावेज़ीकरण की जांच करने पर इस राय पर आधारित किया।

Answer 2

@see जावाडॉक्स में एक अलग पंक्ति बनाता है। {@link} टेक्स्ट के भीतर एम्बेड करने के लिए है।

मैं @see का उपयोग करता हूं जब यह एक संबंधित इकाई है लेकिन मैं इसे एक्सपोजिटरी टेक्स्ट में संदर्भित नहीं करता हूं। जब मैं तंग युग्मन कर रहा हूं, तो पाठ के भीतर लिंक का उपयोग करता हूं, या (मुझे लगता है) यह संभवतः पाठक नेविगेशन संकेत से लाभान्वित होगा, उदाहरण के लिए, आपको इसे सीधे संदर्भित करने की आवश्यकता होगी।