मैं अपने सार वर्ग से विधियों के उत्तराधिकारी के लिए {@inheritDoc} कक्षा का उपयोग करना चाहता हूं। अमूर्त वर्ग के लिए प्रलेखन में, मैं अमूर्त वर्ग को नाम से संदर्भित करता हूं। मैं इसे कैसे टैग कर सकता हूं जब सबक्लास को सुपर क्लास से दस्तावेज़ प्राप्त होता है, तो यह सार वर्ग के नाम को उपclass के नाम से बदल देता है?जावाडोक {@inheritDoc} टैग क्लास
जो आप वर्णन कर रहे हैं वह जावाडोक जनरेशन टूल द्वारा समर्थित नहीं है।
और मुझे लगता है यह भी के लिए एक अच्छा कारण है कि:
हैं उपवर्ग में अपने विधि केवल एक सार विधि के एक कार्यान्वयन है, तो मुझे लगता है कि अमूर्त वर्ग छोड़ने के लिए सही होगा वहां नाम '
फ्लिप पक्ष पर, यदि उप-वर्ग में आपकी विधि केवल एक साधारण कार्यान्वयन नहीं है, और कुछ और उल्लेखनीय है (जवाडोक में उल्लेख किया जाना पर्याप्त है), तो आपको विधि पर एक नया जावाडोक लिखना चाहिए उत्तराधिकारी का आह्वान करने के बजाय उपclass।
मुझे किसी तरह से पता नहीं है, लेकिन आप यह बता सकते हैं कि आप {@inheritDoc} ऐसा क्यों करना चाहते हैं। मैं गलत समझ सकता हूं, लेकिन यह भ्रमित लगता है। आप दस्तावेज कर सकते हैं कि आपका ठोस कार्यान्वयन कैसे माता-पिता के रूप में भिन्न होता है और अमूर्त वर्ग में अनुबंध को संदर्भित करने के लिए @see का उपयोग करता है। नोट "Automatic Copying of Method Comments" एक स्पष्ट {@inheritDoc} की आवश्यकता को रोक सकता है।
मुझे लगता है कि मैं समझता हूं। धन्यवाद। – LandonSchropp
आप भी, आईआईआरसी, अपनी टिप्पणियों में {@inheritDoc} टैग के आस-पास अतिरिक्त टेक्स्ट लिख सकते हैं।
इसके पीछे मेरा तर्क था कि मेरे कोड का पाठक सामान्य रूप से कार्यान्वयन के पीछे अमूर्त वर्ग को नहीं देखेगा, इसलिए मैं इसे छिपाना चाहता था। हालांकि, ऐसा प्रतीत होता है कि मैं ऐसा नहीं कर सकता। फिर भी धन्यवाद। – LandonSchropp
यदि आपकी कक्षा के उपयोगकर्ता को विधि के लिए दस्तावेज़ीकरण की आवश्यकता है, लेकिन उन्हें अमूर्त बेस क्लास के अस्तित्व के बारे में पता नहीं होना चाहिए, तो विधि परिभाषा को एक इंटरफ़ेस में स्थानांतरित किया जाना चाहिए, साथ ही सार वर्ग पर जावाडोक के साथ। संक्षेप में, इंटरफ़ेस वह है जो उपयोगकर्ता के बारे में होगा। उपर्युक्त उत्तर में दोनों बिंदु अभी भी लागू होंगे। – GreenGiant