2011-07-13 15 views
7

मैंने अपने बीन निजी क्षेत्रों को जावाडोक के साथ दस्तावेज किया है, यह बताते हुए कि प्रत्येक फ़ील्ड क्या है। क्या मैं दस्तावेज़ों के डुप्लिकेशंस को कम करने के लिए गेटर्स/सेटर्स को corrseponding करने के लिए किसी भी तरह से इन दस्तावेजों का प्रचार कर सकते हैं? क्या कम से कम इसके लिए किसी प्रकार का जावाडोक मैक्रो है?निजी क्षेत्र javadoc के गेटर्स/सेटर्स के स्वचालित प्रचार?

+2

सुनिश्चित नहीं हैं, लेकिन मैं सिर्फ JavaDoc getters और setters के रूप में वे सार्वजनिक एपीआई का हिस्सा हैं होगा। – Steve

+2

... वास्तव में मैं केवल जेवाडोक विधियों को एपीआई का हिस्सा बनूंगा। –

उत्तर

5

आप एक जावाडोक लिंक जोड़ कर ही टिककर खेल और निजी क्षेत्र के लिए setters के जावाडोक टिप्पणी लिंक कर सकते हैं:

{@link Class#field} 

हालांकि मैं वास्तव में इस की सिफारिश नहीं होगा। जैसा कि पिछले टिप्पणीकारों ने कहा था, मैं सिर्फ गेटर्स और सेटर्स को सही तरीके से दस्तावेज करता हूं। जावाडोक आपके सार्वजनिक एपीआई दस्तावेज करता है, जो गेटर्स और सेटर का हो सकता है। आपके निजी फ़ील्ड सार्वजनिक एपीआई से संबंधित नहीं हैं।

+2

शायद दूसरी तरफ: फ़ील्ड से गेटटर/सेटर तक एक लिंक जोड़ें, इसलिए जो कोई भी '-प्रिवाइट' के साथ प्रलेखन को देखता है, विवरण पर जा सकता है। –