MyClass कन्स्ट्रक्टर के लिए JavaDoc @see एक चेतावनी लौटा रहा है "संदर्भ नहीं मिला"

Question

मैं अपने क्लाइंट लाइब्रेरी के लिए जावाडोक बनाने की कोशिश कर रहा हूं। MyOtherClass में, मैंने नीचे @see डाल दिया है, और चेतावनियां प्राप्त की हैं। MyOtherClass और MyClass दोनों एक ही प्रोजेक्ट में अलग-अलग पैकेजों में हैं।

@see MyClass#Constructor(Type1 param1, Type2 param2) 
warning - Tag @see: reference not found: MyClass#Constructor(Type1 param1, Type2 param2) 

तब मैं

@see MyClass#MyClass(Type1 param1, Type2 param2) 
warning - Tag @see: reference not found: MyClass#MyClass(Type1 param1, Type2 param2) 

इसके अलावा

@see #MyClass(Type1 param1, Type2 param2) 
warning - Tag @see: reference not found: MyOtherClass#MyClass(Type1 param1, Type2 param2) 

मैं जानता हूँ कि मैं यहाँ कुछ असली मूर्खतापूर्ण याद आ रही है की कोशिश की कोशिश की।

Answer 1

ऐसा इसलिए है क्योंकि जावाडोक को उस वर्ग के सटीक स्थान को जानने की आवश्यकता है जिसे आप संदर्भित कर रहे हैं। उपर्युक्त टिप्पणी में उल्लिखित पैकेज को बस जोड़ें।

@see mypackage.MyClass#Constructor(Type1 p1, Type2 p2) 

जावाडोक उपकरण आप शॉर्टकट के रूप में इस लेने के लिए अनुमति देगा:

@see mypackage.MyClass#Constructor(Type1 p1, Type2 p2) MyClass#Constructor(Type1 p1, Type2 p2) 

:

// For methods in the same class: 
@see #Constructor(Type1 p1, Type2 p2) 

// For methods in the same package: 
@see MyClass#Constructor(Type1 p1, Type2 p2) 

आप एक लंबे पैकेज का नाम है और यह छिपाना चाहते हैं तो आप एक लेबल का उपयोग कर सकते

उपर्युक्त प्रदर्शित होगा:

यह भी देखें:MyClass.Constructor(Type1 p1, Type2 p2)

@see

---

चेतावनी के बारे में अधिक के लिए Oracle प्रलेखन here देखें: क्या आप कुछ IDEs का कोड पूर्णता सुविधा का उपयोग करते (उदा ग्रहण) Javadoc टिप्पणियां बनाने के लिए यह उस पैकेज के लिए एक आयात जोड़ सकता है जिसका आप संदर्भ दे रहे हैं। हालांकि यह पैकेज टिप्पणियों को छोड़कर आपकी टिप्पणियां साफ़ कर सकती है, लेकिन दस्तावेज़ों के लिए पूरी तरह वास्तविक निर्भरताओं को जोड़ने का अच्छा अभ्यास नहीं है।