2017-06-26 10 views
7

मेरी स्थिति है कि मेरे पास किसी तृतीय पक्ष से बाहरी संकलित लाइब्रेरी (जार) नहीं है जिसमें जावाडॉक्स नहीं हैं। जैसा कि मैं विकास कर रहा हूं, मैं तीसरे पक्ष की वेबसाइट से प्राप्त बहुत सीमित दस्तावेज़ीकरण का परीक्षण और उपयोग करके कक्षाओं और विधियों को दस्तावेज करना चाहता हूं।बाहरी पुस्तकालय के लिए JavaDocs लिखें

मेरा अंतिम लक्ष्य जावाडॉक दस्तावेज होना है जिसे मैं कोड-हिंटिंग और दस्तावेज़ीकरण लुकअप के लिए इंटेलिजे में उपयोग करने में सक्षम हूं?

तो मेरा सवाल यह है कि क्या जावाडॉक्स को पहले से संकलित जार फ़ाइल में लिखना संभव है जिसे मैं आयात करने में सक्षम हूं? शायद एक उपकरण का उपयोग करना जो इसकी सहायता करता है।

उत्तर

4

हां यह है। आपको बस इतना करना है कि कक्षा और इंटरफ़ेस और विधि और चर परिभाषाएं किसी भी कोड के बिना लिखें, हालांकि सभी विधियां अमूर्त थीं, और फिर उन लोगों के लिए जावाडोक टिप्पणियां लिखें। वास्तव में, कैसे सूर्य ने कोडकों को जारी करने के लिए निर्माण प्रक्रिया में देरी प्रक्रिया के साथ तकनीकी लेखकों और संपादकों (हाय डौग!) द्वारा नियंत्रित एक पूरी तरह से अलग स्रोत पेड़ के माध्यम से जावाडोक का उत्पादन किया।

+0

क्या आप एक त्वरित कोड उदाहरण दिखा सकते हैं? यह आपके उत्तर को स्पष्ट बनाने में मदद करेगा। – byxor

+0

बस विधियों को लिखें जैसे कि वे अमूर्त थे, बिना 'अमूर्त' कीवर्ड के, यानी विधि निकाय के बजाय सिर्फ अर्धविराम। आप इसे संकलित नहीं कर सकते हैं, लेकिन आप इसे जावाडोक कर सकते हैं। – EJP

+0

यह काम किया! मैंने इसके लिए एक अलग परियोजना बनाई और जैसा आपने कहा था वैसा ही किया। परियोजना त्रुटियों से भरी जाएगी लेकिन जावाडॉक जेनरेटर के साथ कोई समस्या नहीं है। मेरे मुख्य प्रोजेक्ट में मैंने दस्तावेज़ संलग्न किए और यह एक आकर्षण की तरह काम किया। धन्यवाद :) – JensV

संबंधित मुद्दे