11
मैं अनावश्यक जावाडोक टिप्पणियां लिखना नहीं चाहता हूं। जैसा कि आप देख सकते हैं, @param x एक तरह से अनावश्यक है। से कक्षा B से @param x में A में संदर्भ सेट करने के लिए कोई जावाड मार्कअप है या क्या मुझे इसे छोड़ने की अनुमति है?किसी अन्य विधि से Javadoc संदर्भ param
/**
* Class A constructor
*
* @param x position on x-axis
*/
public A(final int x) {
this.x = x;
}
/**
* Class B constructor
*
* @param x position on x-axis
* @param y position on y-axis
*/
public B(final int x, final int y) {
super(x);
this.y = y
}
मैं एक कदम वापस ले जाऊंगा और पूछूंगा कि आप पैरामीटर दस्तावेज क्यों कर रहे हैं जो स्पष्ट अर्थ प्रतीत होता है। यदि कोड आपके द्वारा चुने गए नामों के आधार पर स्वयं-दस्तावेज है, तो जावाडॉक काफी हद तक अप्रासंगिक है। –
@ जॉन यह चित्रण के लिए केवल एक न्यूनतम उदाहरण है। – Matthias
अपने आप को ध्यान दें: [{@inheritDoc}] (http://docs.oracle.com/javase/1.4.2/docs/tooldocs/windows/javadoc.html#inheritingcomments) कम से कम एक ओवरराइड विधि के एक दस्तावेज़ की प्रतिलिपि बनाने की अनुमति देता है । – Matthias