मैं DRY तरीके से Javadoc लिखना चाहता हूँ। लेकिन Javadoc के बारे में ओरेकल दस्तावेज़ कहता है कि ओवरलोड विधि टिप्पणी में फिर से वही लिखें। क्या मैं पुनरावृत्ति से बच नहीं सकता?
मैं DRY तरीके से Javadoc लिखना चाहता हूँ। लेकिन Javadoc के बारे में ओरेकल दस्तावेज़ कहता है कि ओवरलोड विधि टिप्पणी में फिर से वही लिखें। क्या मैं पुनरावृत्ति से बच नहीं सकता?
जवाबों:
{@inheritDoc}सुपरक्लेसेस से तरीकों को ओवरराइड करने या इंटरफ़ेस-परिभाषित तरीकों को लागू करने पर मैं अपने जावदोक टिप्पणियों में यहां और वहां निर्देश छिड़कता हूं ।
यह कम से कम मेरे लिए अच्छी तरह से काम करता है, स्रोत कोड में पुनरावृत्ति से बचा जाता है, और यदि आप ऐसा करने की आवश्यकता है, तब भी आप विशेष रूप से जावदोक टिप्पणी में विशिष्ट जानकारी जोड़ सकते हैं। मैं इस तथ्य पर विचार नहीं करता कि जावदोक टिप्पणी स्वयं किसी भी मुद्दे पर काफी मुश्किल है जब सभी को एक सभ्य आईडीई में लिया जाता है, संबंधित पहचानकर्ता नाम पर संदर्भ और सभी के साथ प्रदान करने के लिए जावदॉक को प्राप्त करना है।
प्रलेखन का उद्देश्य किसी वस्तु के भावी उपयोगकर्ताओं को रोशन करना है। यह आंशिक रूप से लेखक की सुविधा के लिए है, ताकि जब भी कोई यह पता न लगा सके कि वह कैसे काम करता है, तो उससे संपर्क नहीं किया जाता है। ज्यादातर, हालांकि, यह उन लोगों के लाभ के लिए है जिन्हें इस चीज का उपयोग करने या समर्थन करने की आवश्यकता है।
जैसे, लेखक के लिए सुविधा के विपरीत, बिंदु स्पष्टता होना चाहिए। आप अपने एपीआई प्रलेखन के माध्यम से लोगों से शिकार करने की उम्मीद नहीं कर सकते क्योंकि आप अनिवार्य रूप से खुद को दोहराने के लिए बहुत आलसी थे। इसे चूसो - जावदोक दोहराव होगा।
उस ने कहा, कोई कारण नहीं है, अगर आप चतुर हैं, तो आप एक प्रोग्राम नहीं लिख सकते हैं जो मार्कर या कुछ अन्य मानदंडों के आधार पर आपके कोड में टिप्पणियां चिपकाएगा। इसके लायक होने से ज्यादा परेशानी हो सकती है। या नहीं।