2010-04-08 15 views
6

सहित अनुपूरक विधियों को जोड़ें, ग्रहण में एक इंटरफ़ेस को कार्यान्वित करते समय, यह वास्तव में एक अच्छी सुविधा है जो आपको "अनुपूरक तरीकों को जोड़ने" देती है, और यह इंटरफ़ेस विधियों के लिए विधि स्टब्स उत्पन्न करेगी।ग्रहण javadoc

हालांकि, यह इंटरफ़ेस विधियों से विधि प्रलेखन के साथ नहीं लाता है, और मैं सोच रहा था कि ऐसा करने के लिए ग्रहण करने का कोई तरीका था या नहीं।

यहां मैं क्या करना चाहता हूं। मान लीजिए कि मैं इस तरह एक अंतरफलक था करते हैं:

public interface BaseInterface { 

    /** 
    * This method takes the given string parameter and returns its integer value. 
    * 
    * @param x the string to convert 
    * @return the integer value of the string 
    * 
    * @throws Exception if some error occurs 
    */ 
    int method1(String x); 
} 

अब मैं एक वर्ग MyClass कहा जाता है जो इस इंटरफेस को लागू करता है बनाएँ। क्या मैं क्या करना चाहते है कि जब मैं कहता हूँ "लागू नहीं किया गया तरीके जोड़ें" है, मैं अपने कोड इस तरह दिखना चाहते हैं:

public class MyClass implements BaseInterface { 

    /** 
    * This method takes the given string parameter and returns its integer value. 
    * 
    * @param x the string to convert 
    * @return the integer value of the string 
    * 
    * @throws Exception if some error occurs 
    */ 
    public int method1(String x) { 
     return 0; 
    } 

} 

उत्तर

5

हाँ: इन तरीकों कोड टेम्पलेट्स आप ने लिखा का उपयोग कर उत्पन्न कर रहे हैं।

आप में "विंडो/प्राथमिकताएं -> जावा/कोड शैली/कोड टेम्पलेट्स" के लिए जाना होगा,

फिर, सूची में से चुनें "टिप्पणी/अधिभावी तरीकों" और एक के साथ सामग्री को बदलने आप "टिप्पणी/तरीकों" में पाया:

/** 
* ${tags} 
*/ 

तुम भी एक ${see_to_overridden} जोड़ने मूल विधि लिए एक सीधा लिंक के लिए के बारे में सोच सकते हैं। हालांकि, ध्यान दें कि कोई जवाडोक वाला कोई तरीका स्वचालित रूप से अपने ओवरडिन से अपने जावाडोक को प्राप्त नहीं करेगा, इसलिए ऐसा टेम्पलेट डिफ़ॉल्ट व्यवहार से कम प्रासंगिक दस्तावेज़ उत्पन्न कर सकता है।

+0

मैंने कोशिश की, लेकिन यह काम नहीं किया। इसने विधि के लिए कोई दस्तावेज़ नहीं बनाया। – dcp

0

आप JavaDoc एनोटेशन द्वारा इसे प्राप्त कर सकते हैं। यह विशिष्ट ग्रहण नहीं कर रहा है और सभी निर्माण/doc पीढ़ी उपकरण में काम करेंगे:

/** 
* My custom decumentation, and then the original one: 
* 
* {@inheritDoc} 
*/ 
संबंधित मुद्दे