2009-10-05 13 views
81

का उपयोग करके एक एनम वैल्यू को लिंक करने के लिए कैसे करें Javadoc 1.5 का उपयोग करके, मैं एक गणना मूल्य के लिए @ लिंक बनाने में असमर्थ हूं।जावाडोक

public enum Planet { 

/** 
* MERCURY is a fun place. 
*/ 
MERCURY, 

/** 
* VENUS is more fun. 
*/ 
VENUS, 

/** 
* But nothing beats the Earth. 
*/ 
EARTH, 

/** 
* Others we know nothing about. 
*/ 
OTHERS 
} 

और फिर इस तरह एक लिंक का उपयोग पृथ्वी के लिए जावाडोक का संदर्भ लें::

मैं करना चाहते हैं क्या इस तरह की एक Enum बनाने के लिए है

{@link Planet.EARTH} 

मैं कोशिश की है {@link Planet#EARTH} शैली भी, लेकिन कोई फायदा नहीं हुआ।

कोई भी जानता है कि यह बिल्कुल करने योग्य है या नहीं?

उत्तर

126

# शैली मेरे लिए काम करता है:

{@link Planet#EARTH} 

महत्वपूर्ण यह है कि ग्रह पैकेज आयात किया जाना चाहिए है, या ग्रह पूरी तरह से योग्य होना चाहिए - यानी: जब तक यह आयातित है

{@link com.something.somethingelse.Planet#EARTH} 
+0

जैसा कि sfussenegger ने नोट किया है, ग्रहण आपके लिए आयात को संभालता है। – aperkins

+0

धन्यवाद दोनों उत्तर सहायक हैं! मैं इसे पूरी तरह से योग्य संदर्भ का उपयोग कर काम करने के लिए मिला। कभी-कभी संकलक आउटपुट यह निर्धारित करने में वास्तव में सहायक नहीं होता है कि समस्या क्या है ... –

+2

क्या कक्षा ए के भीतर enum परिभाषित किया गया है और कोई कक्षा बी जावाडोक से अपने मूल्यों में से किसी एक को संदर्भित करने का प्रयास कर रहा है? मुझे ओपनजेडीके 1.6 अपडेट 24 जावाडोक के लिए काम करने के लिए न तो एप्लानेट # ईर्थ और न ही # प्लैनेट # धरती मिली है, हालांकि ग्रहण A.Planet # धरती शैली के साथ घोषणा ढूंढना जानता है। –

4

मैं इस जांच करने के लिए ग्रहण का उपयोग कर रहा है, लेकिन

{@link Planet#EARTH} 

शैली काम करने के लिए लगता है। हालांकि, मैं आमतौर पर

@see Planet#EARTH 

वैसे भी पसंद करते हैं। सुनिश्चित नहीं है कि ग्रहण जेवाडोक उत्पन्न करने के लिए क्या उपयोग करता है, लेकिन मैं जेडीके 6 का उपयोग कर रहा हूं। फिर भी, शायद @see आपके लिए चाल है।

+2

मुझे '@ देखें' पसंद है लेकिन कभी-कभी आपको विशेष मामलों की आवश्यकता होती है। उदाहरण के लिए, मेरे आदेशों में 'isWithdrawn()' विधि है, और मैं विशेष रूप से कहता हूं 'अगर इस आदेश की स्थिति ऑर्डरस्टैटस # के साथ बराबर है, तो गलत है, अन्यथा – corsiKa

2

आप इसे लिंक कर सकते हैं (लेकिन जब आप ऐसा करते हैं, तो आईएमओ यह आयात को गन्दा बनाता है- कोड में किस चीज का उपयोग किया जाता है और जवाडोक में क्या होता है? मुझे बस पूरी तरह से योग्य नाम का उपयोग करना पसंद है)।

लेकिन हाँ, ग्रहण यह सब की देखभाल कर सकते हैं और मानक

{@link Planet#EARTH} 

ठीक काम करता है।

यदि आप एक्लिप्स, Ctrl + Shift + O (पीसी पर) या सीएमडी + शिफ्ट + ओ (मैक पर) का उपयोग करते हैं तो अपने आयात को स्वतः समायोजित करें (इसका मतलब है कि यदि आपके पास अतिरिक्त आयात नहीं किए जा रहे हैं, तो उन्हें हटा दिया जाता है, साथ ही साथ आपको आवश्यक आयात भी जोड़ना)।

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