2011-08-19 6 views
15

मैंने एक एपीआई बनाया है जिसे मैं एक जेएआर फ़ाइल के रूप में रिलीज़ करता हूं। यह स्वामित्व है इसलिए मुझे स्रोत फाइलों को इसमें से बाहर करना पड़ा।मैं javadocs के लिए एक जार वितरित कैसे बना सकता हूं?

वर्तमान में मैं एक अलग/दस्तावेज़ फ़ोल्डर शामिल करता हूं जिसमें एक्लिप्स के निर्यात-टू-जावाडोक विज़ार्ड का आउटपुट शामिल है। बुरा नहीं है, लेकिन मैं एक कदम आगे जाना चाहता हूं।

मैं javadocs को एक जार फ़ाइल के रूप में वितरित करना चाहता हूं जिसे आसानी से भविष्य में प्रोजेक्ट में गिराया जा सकता है जिसमें मेरे एपीआई के लिए जार फ़ाइल शामिल है। मुझे पता है कि मैंने इसे कई अन्य वितरणों के साथ कई बार देखा है, लेकिन मेरे पास कोई भाग्य खोज नहीं है।

अंतिम लक्ष्य भविष्य के डेवलपर्स को टिप्पणियों और उस प्रकृति की चीजों पर होवर करने के लिए आसान पहुंच प्रदान करने की अनुमति देना है।

धन्यवाद!

+0

कम से कम आपके प्रश्न के दूसरे भाग के लिए ... यहां जावाक्लक्स को ग्रहण में रखने के तरीके के बारे में विस्तृत निर्देश दिए गए हैं http://stackoverflow.com/a/11579339/356895 – JJD

उत्तर

11

यह है कि यह एक जार फ़ाइल के रूप में उत्पन्न दस्तावेज़ीकरण डॉक ग्रहण वाले फ़ोल्डर पैकेज के लिए पर्याप्त है लगता है। तो फिर तुम वास्तविक जार .class संकलित फ़ाइलों से युक्त के javadocs के रूप में है कि जार उपयोग करना चाहते हैं, तो आप ग्रहण में "संग्रह में जावाडोक" के साथ जावाडोक जार आवंटित और डॉक के रूप में संग्रह भीतर पथ निर्धारित किया है। ऐसा लगता है कि ग्रहण index.html और पैकेज-सूची दस्तावेज़ फ़ोल्डर में प्रविष्टियों के लिए दिखता है।

Setting Javadoc location in Eclipse

मैवेन-जावाडोक-प्लगइन का उपयोग करना भी ऐसा करने का एक आसान तरीका हो सकता है। नीचे दिए गए लिंक देखें: अपने अंतिम लक्ष्य भविष्य डेवलपर्स जब वे अपनी कक्षाओं या तरीकों का उपयोग कर रहे हैं अपने जावाडोक निर्देश देखने के लिए सक्षम होने के लिए बस के लिए है, तो

http://www.avajava.com/tutorials/lessons/how-do-i-generate-and-deploy-a-javadoc-jar-file-for-my-project.html

+0

अनुशंसा के लिए धन्यवाद। मैं वास्तव में जावाडोक मेवेन प्लग-इन में ठोकर खा गया था, हालांकि मैं एक गैर-मेवेन प्रोजेक्ट में मैवेन पेश नहीं करना चाहता था। मैं वास्तव में प्लग-इन क्या कर रहा हूं, इस बारे में और अधिक देखने जा रहा हूं, और यह मुझे समझने में मदद कर सकता है कि कैसे मैवेडोक जार को मेवेन के बिना उत्पन्न करना है। मदद की सराहना करते हैं, मैं किसी भी अन्य निष्कर्षों का पालन करूंगा। – Batman0730

+0

@ Batman0730 मैंने जवाब संपादित किया है। क्या आप कृपया बताए गए तरीके का प्रयास कर सकते हैं? – suat

+1

मुझे लगता है कि यह एक गलतफहमी को साफ़ करता है जो मैंने साथ किया है। आप इन javadoc.jar फ़ाइलों को किसी प्रोजेक्ट में नहीं छोड़ सकते हैं और जादुई रूप से कोड से जुड़े टिप्पणियां प्राप्त कर सकते हैं। आपको अपने पुस्तकालयों में मैन्युअल रूप से javadocs संलग्न करना होगा, भले ही वे .jar प्रारूप में हों। मैंने पहले कभी इसका परीक्षण नहीं किया था, इसलिए मेरी धारणा सभी के साथ गलत थी। आपकी मदद के लिए धन्यवाद। – Batman0730

0

, ग्रहण में आप जावा निर्यात करने का विकल्प हो सकता है स्रोत फ़ाइलों जब आप अपने जार पुस्तकालय निर्यात नीचे वाले चित्र में दिखाया गया है:

enter image description here

यह भी डेवलपर्स में कदम और अपने कोड को देख जबकि डिबगिंग के लिए अनुमति देता है।

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