जावदोक को एक वर्ग की व्यक्तिगत दुश्मनी कैसे


84

मैं एक वर्ग के लिए javadoc लिख रहा हूं जिसमें यह स्वयं का शब्द है। वहाँ अलग-अलग enums के लिए javadoc उत्पन्न करने के लिए एक रास्ता है? उदाहरण के लिए, अभी मेरे पास कुछ ऐसा है:

/**
 * This documents "HairColor"
 */
private static enum HairColor { BLACK, BLONDE, BROWN, OTHER, RED };

हालाँकि, यह केवल एक के रूप में सभी एनमों के सभी दस्तावेज:

उत्पन्न जावदोक

क्या हेयरकलर मूल्यों में से प्रत्येक को व्यक्तिगत रूप से दस्तावेज करने का कोई तरीका है? बिना एनम को घुमाए यह अपनी कक्षा में है या इसे एनम से बदल रहा है?

किसी भी सहायता के लिए अग्रिम रूप से धन्यवाद।


जिज्ञासा से बाहर, आप क्यों करना चाहते हैं? आपके पास एनुम एक privateनेस्टेड एनम के रूप में सूचीबद्ध है , इसलिए आपकी कक्षा के उपयोगकर्ता वैसे भी एनम या उसके मूल्यों का उपयोग नहीं कर सकते हैं। और अगर इसका मतलब सार्वजनिक और स्वसंपूर्ण होना है, तो इसे अपनी इकाई के रूप में दर्ज करने में क्या बड़ी बात है?
मार्क पीटर्स

2
मेरे वास्तविक कोड में, यह सार्वजनिक है। और आप जानते हैं कि कंपनी के मानक कैसे हो सकते हैं। "यह बेहतर होगा" "बहुत बुरा, हम जो प्रोग्रामिंग के बारे में कुछ भी नहीं जानते हैं आपको लगता है कि आपको इसे इस तरह करना चाहिए"। लोल
बर्फीली कोडर गर्ल

काफी उचित। बस यह सुनिश्चित करें कि आप उन्हें बताएं कि प्रलेखन के लिए अमूल्य आवश्यकताओं के कारण रिलीज़ को एक सप्ताह पीछे धकेल दिया जाएगा जो शायद कभी नहीं पढ़ा जाएगा। यह आमतौर पर किसी ऐसे व्यक्ति के कानों को चुभता है जो व्यापार के बारे में बिल्कुल परवाह करता है।
मार्क पीटर्स

1
Haha। Javadoc को javadoc के रूप में उपयोग नहीं किया जाता है। लेकिन मुझे यह कोडिंग से प्यार है। कुछ प्रोग्रामर के पास ऐसे नाम होते हैं जिनका वास्तव में कुछ भी नहीं होता है। जैसे गेटकैट उन सभी बिल्लियों को लौटाता है जो पिछले 10 दिनों में एक पेड़ से भाग गए हैं, मंगलवार या छुट्टियों सहित नहीं। Haha
हिमाच्छन्न कोडर लड़की

@RachelG। यह काफी घटना है कि हर देवता सोचता है कि वह अन्य देवों से श्रेष्ठ है। हालांकि कोई अपराध नहीं।
OddDev

जवाबों:


99

आप इसे किसी भी अन्य वैरिएबल की तरह ही करेंगे जो आप javadoc करेंगे।


/**
 *  Colors that can be used
 */
public enum Color
{
    /**
     * Red color
     */
    red,

    /**
     * Blue color
     */
    blue

}

संपादित करें:

पाओलो एबरमन से: एनम एक अलग वर्ग है। आप इसके पूर्ण दस्तावेज़ को एन्कोडिंग कक्षा में शामिल नहीं कर सकते (कम से कम, मानक डॉकलेट को पैच किए बिना)।


2
यह एक ही चीज़ उत्पन्न करता है (स्नैपशॉट पर लिंक पर ध्यान दें)। मैं उन्हें सीधे क्लास जेवाडॉक (दूसरे जेवॉडॉक से जोड़ने के बजाय) में डालना चाहता हूं। लेकिन समस्या वर्णन को आगे बढ़ाने के लिए धन्यवाद =) +1।
कोडर गर्ल

4
@ राशेल: एनम एक अलग वर्ग है। आप इसके पूर्ण दस्तावेज़ को एन्कोडिंग कक्षा में शामिल नहीं कर सकते (कम से कम, मानक डॉकलेट को पैच किए बिना)।
पाओलो एबरमन जू

हाँ। मुझे इस बात की चिंता थी कि लिंकिंग के समय यह कैसा था। मुझे लगता है कि व्यक्तिगत दुश्मनी को शामिल करने का एकमात्र तरीका यह होगा कि इसे एक आंतरिक वर्ग में बदल दिया जाए और फिर वहां की वस्तुओं को घोषित किया जाए और उनका मजाक उड़ाया जाए।
कोडर गर्ल

@ user489041: क्या आप भविष्य में संदर्भ के लिए महत्वपूर्ण टिप्पणियों (जैसे मेरे एक) को शामिल कर सकते हैं?
पाओलो एबरमन

यदि आप इसे संदर्भित करना चाहते हैं, तो आप हमेशा उपयोग कर सकते हैं {@link Color}या {@link Color#red}उदाहरण के लिए, या यहां तक ​​कि {@link #red}जब एक ही दस्तावेज़ में किसी भी अन्य javadoc के भीतर से, वर्ग javadoc सहित।
फ्लुंगो

69

आप प्रत्येक एनम के आइटम के लिए लिंक बना सकते हैं। सभी वस्तुओं को javadocs में enum class में सूचीबद्ध किया जाएगा।

/**
 *  Colors that can be used
 *  {@link #RED}
 *  {@link #BLUE}
 */
public enum Color {

    /**
     * Red color
     */
     RED,

    /**
     * Blue color
     */
    BLUE
}
हमारी साइट का प्रयोग करके, आप स्वीकार करते हैं कि आपने हमारी Cookie Policy और निजता नीति को पढ़ और समझा लिया है।
Licensed under cc by-sa 3.0 with attribution required.