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