किसी विधि को दस्तावेज़ कैसे करें जो किसी अन्य विधि को ओवरराइड करता है?

Question

मैंने हमेशा सोचा कि कैसे एक विधि को दस्तावेज करना है जो बेस क्लास से संदेश को ओवरराइड करता है। आम तौर पर मैं प्रत्येक सार्वजनिक विधि और कुछ निजी, संरक्षित तरीकों के लिए एक जावा दस्तावेज़ जोड़ता हूं।

/* 
* (non-Javadoc) 
* 
* @see javax.swing.JComponent#paintComponent(java.awt.Graphics) 
*/ 

इस ओवरराइड दस्तावेज़ के लिए एक अच्छा तरीका है:

लेकिन ग्रहण में एक ओवरराइड विधि के लिए एक प्रलेखन ब्लॉक autogenerating कुछ इस तरह उत्पादन होता है? क्या मुझे बेस क्लास से दस्तावेज़ों का उत्तराधिकारी/प्रतिलिपि बनाना चाहिए?

इस विशेष मामले के लिए आप दस्तावेज़ के रूप में क्या कर रहे हैं? मैं प्रथाओं का एक अवलोकन करना चाहता हूं जिनका उपयोग किया जाता है।

Answer 1

प्रत्येक विधि - निजी, संरक्षित सार्वजनिक - यह वर्णन करने के लिए दस्तावेज किया जाना चाहिए कि यह क्या करता है। बेस क्लास से दस्तावेज़ीकरण प्राप्त करने के बारे में भूल जाओ - यदि आप चाहें तो इसमें एक लिंक शामिल कर सकते हैं, लेकिन जब तक सूचना है कि यह विरासत विधि को ओवरराइड करता है तो दूसरा व्यक्ति स्वयं को देखने के लिए स्वतंत्र होता है। DRY - अपने आप को दोहराना न करें - बेस क्लास विधि को केवल एक ही स्थान पर दस्तावेज़ करें।

मुझे यह भी नहीं लगता कि यह किस दस्तावेज़ को ओवरराइड करता है, यह दस्तावेज करना अच्छा है, क्योंकि यह बदल सकता है और यदि आप अपनी कक्षा और बेस क्लास के बीच पदानुक्रम में नई कक्षाएं डालते हैं तो इसे अद्यतित रखना मुश्किल होगा । केवल वह जानकारी जो विरासत विधि को ओवरराइड करती है वह पर्याप्त है।

यदि आपकी विधियां टिप्पणियों की कुछ पंक्तियों में दस्तावेज़ के लिए बहुत जटिल हैं, तो वे शायद बहुत जटिल हैं और उन्हें दोबारा प्रतिक्रिया दी जानी चाहिए।

Answer 2

@ ओवरराइड एनोटेशन सहित सुपर को उत्सुक डेवलपर भेजने के लिए पर्याप्त होना चाहिए।