जावा में पदावनत वर्ग की टिप्पणी करने का सबसे अच्छा तरीका क्या है?


11

मैं जावा में पदावनत वर्ग की पहचान करने के लिए टिप्पणी जोड़ने का सबसे अच्छा तरीका जानना चाहूंगा। क्या मुझे उस कक्षा के शीर्ष पर जोड़ी गई पिछली टिप्पणी को हटा देना चाहिए जो किसी अन्य प्रोग्रामर को यह जानने में मदद करती है कि वह कक्षा किस लिए थी, या क्या मुझे इसे टिप्पणी के नीचे जोड़ना चाहिए?

जवाबों:


17

जावा में एक वर्ग, विधि या क्षेत्र को अपदस्थ करने के लिए अनुशंसित दृष्टिकोण @Deprecatedएनोटेशन का उपयोग करना है , जो जावा 5 में उपलब्ध है, या @deprecatedजावाडॉक टैग, जो कि जावा 1.1 के बाद से आसपास है। ओरेकल के पास एपीआई के बारे में एक दस्तावेज है कि कैसे और कब प्रासंगिक एपीआई प्रतीत होता है।

क्या मुझे उस कक्षा के शीर्ष पर जोड़ी गई पिछली टिप्पणी को हटा देना चाहिए जो किसी अन्य प्रोग्रामर को यह जानने में मदद करती है कि वह टिप्पणी के लिए वह वर्ग कौन सा था या उसे नीचे जोड़ें?

आपको JavaDoc टैग या एनोटेशन जोड़ने के अलावा, किसी भी मौजूदा टिप्पणी को संपादित या हटाना नहीं चाहिए। पदावनत कोड अभी भी विरासत प्रणालियों में उपयोग में हो सकता है, और उन प्रणालियों के डेवलपर्स को प्रलेखन तक पहुंच की आवश्यकता होती है जो मूल डेवलपर्स ने किसी रूप में किया था।


1
+1: @Depricated एनोटेशन का उपयोग करना भी ग्रहण के समान IDEs को एक सिर देता है ताकि यह सुनिश्चित हो सके कि वह विधि को पार कर सके और डेवलपर्स को अन्य दृश्य संकेत दे सके।
रयान हेस

हाँ, मुझे पता है कि कैसे पदच्युत किया जा सकता है और मेरे प्रश्न के अनाउंसमेंट का उपयोग होता है उदाहरण के लिए मेरे पास यह कोड / ** * कक्षा के बारे में टिप्पणी है / / सार्वजनिक वर्ग ClassToDeprecate {// कुछ कोड यहाँ} क्या मुझे टिप्पणी को हटाना चाहिए और इस तरह होना चाहिए
alculete

1
@Spammer मैं जिस लेख से जुड़ा था, उस पर चर्चा की। इसके अलावा, जावा एपीआई प्रलेखन के माध्यम से ब्राउज़ करने से उत्तर मिलता है कि। केवल एक चीज जो आपको करनी चाहिए वह है @Deprecatedएनोटेशन या @deprecatedJavaDoc टैग। वह यह है - और कुछ नहीं, और कुछ नहीं।
थॉमस ओवेन्स

वैसे, आपके द्वारा दिया गया लिंक बहुत मददगार था
alculete

1
@deprecatedJavaDoc टैग और विवरण को @Deprecatedएनोटेशन के साथ जोड़ने से यह अधिक प्रकाश में आ जाएगा कि इसे क्यों हटाया गया था। इसलिए केवल @Deprecatedएनोटेशन के बजाय दोनों का उपयोग करना अधिक फायदेमंद होगा ।
वारफॉक्स
हमारी साइट का प्रयोग करके, आप स्वीकार करते हैं कि आपने हमारी Cookie Policy और निजता नीति को पढ़ और समझा लिया है।
Licensed under cc by-sa 3.0 with attribution required.