129
मैं सूर्य की साइट पर जावाडोक दस्तावेज़ों को देख रहा हूं, यह पता लगाने की कोशिश कर रहा हूं कि कोई जावाड टैग है जिसे किसी वर्ग या विधि के जेनेरिक प्रकार हस्ताक्षर को दस्तावेज करने के लिए उपयोग किया जा सकता है।जेनेरिक टाइप पैरामीटर दस्तावेज करने के लिए कोई जावाड टैग है?
कुछ @typeparam की तरह कुछ, सामान्य @param के समान, लेकिन प्रकारों के साथ-साथ विधियों, जैसे लागू होते हैं।
/**
* @typeparam T This describes my type parameter
*/
class MyClass<T> {
}
मुझे लगता है कि ऐसी कोई टैग है - मैं इसके बारे में कोई जिक्र नहीं कहीं भी मिल सकते हैं, और JavaSE एपीआई डॉक्स यह का कोई भी संकेत नहीं दिखा है, लेकिन यह एक अजीब चूक की तरह लगता है। क्या कोई मुझे सही लगा सकता है?
उचित javadocs लिखने के लिए? –
ध्यान रखें कि * अधिकांश * वर्गों के लिए वास्तव में टाइप पैरामीटर के बारे में कुछ भी दिलचस्प नहीं है, क्योंकि प्रकार पैरामीटर अनिवार्य रूप से परिभाषित किया जाता है कि यह वस्तु के तरीकों में कैसा दिखाई देता है। मैं '@param' ज्यादातर समय छोड़ दूंगा और जब यह वास्तव में स्पष्ट नहीं होता है तो केवल इसका उपयोग करें। –
मैं देख रहा हूं कि आप क्या कह रहे हैं, लेकिन उस तर्क से, यह विधि पैरामीटर के लिए '@ param' के उपयोग पर लागू होता है। सूर्य के कोडिंग मानकों का स्पष्ट रूप से कहना है कि विधि पैरामीटर का अर्थ स्पष्ट होने पर भी 'param' का उपयोग किया जाना चाहिए। – skaffman