Javadoc @see या {@link}?

Question

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

या बल्कि, जब उनमें से किसका उपयोग करना है?

Answer 1

इस पर आधिकारिक दिशानिर्देश बहुत स्पष्ट हैं।

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

• {@link} एक इनलाइन लिंक है और आपको जहां चाहें वहां रखा जा सकता है
• @see अपना स्वयं का अनुभाग बनाता है

मेरी राय में, {@link} सबसे अच्छा तब उपयोग किया जाता है जब आप अपने विवरण में शाब्दिक रूप से एक वर्ग, क्षेत्र, निर्माता या विधि का उपयोग करते हैं। उपयोगकर्ता आपके द्वारा लिंक किए गए के jadadoc पर क्लिक कर सकेगा।

मैं @see2 मामलों में एनोटेशन का उपयोग करता हूं :

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

मैं मानक पुस्तकालय में चीजों की एक महान विविधता के लिए प्रलेखन की बेतरतीब ढंग से जांच करने पर यह राय आधारित हूं।

Comments

Javadoc चेतावनी देता है कि @link बल्कि गहन है और इसका उपयोग केवल आवश्यक होने पर ही किया जाना चाहिए।

— थॉमस

किसी को भी देखने के लिए, आप ओरेकल के जेवाडॉक गाइड@link में इस पर ( ऊपर टिप्पणी में चेतावनी के बारे में सहित) विवरण प्राप्त कर सकते हैं ।

— ऐश रयान अर्नविन

Answer 2

@seeJavadocs में एक अलग लाइन बनाता है। {@link}पाठ के भीतर एम्बेड करने के लिए है।

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

Answer 3

एक और संदर्भ (प्रतिवाद अनुभाग) ही है सरकारी डॉक्स को पसंद करते हैं {@link}अधिक @see(जावा 1.2 के बाद से):

Javadoc 1.2 और बाद के लिए, मानक प्रारूप @deprecated टैग और इन-लाइन {@link} टैग का उपयोग करना है। यह लिंक को इन-लाइन बनाता है, जहाँ आप इसे चाहते हैं। उदाहरण के लिए:

Javadoc 1.1 के लिए, मानक प्रारूप @deprecated और @see टैग की एक जोड़ी बनाना है। उदाहरण के लिए: