कैसे क्लास के व्यक्तिगत Enums Javadoc करने के लिए

Question

मैं उस वर्ग के लिए जावाडोक लिख रहा हूं जिसमें इसके स्वयं के enums शामिल हैं। व्यक्तिगत enums के लिए javadoc उत्पन्न करने का कोई तरीका है?

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

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

वहाँ HairColor से प्रत्येक दस्तावेज़ के लिए कोई तरीका है उदाहरण के लिए, अभी मैं इस तरह कुछ है व्यक्तिगत रूप से मूल्य? Enum को अपनी कक्षा में ले जाने या इसे enum से बदलकर?

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

Answer 1

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

 

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

    /** 
    * Blue color 
    */ 
    blue 

} 
 

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

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

Answer 2

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

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

    /** 
    * Red color 
    */ 
    RED, 

    /** 
    * Blue color 
    */ 
    BLUE 
}