6
बिल्ड प्रक्रिया के हिस्से के रूप में जावाडोक उत्पन्न करना आवश्यक है?बिल्ड प्रक्रिया के हिस्से के रूप में जावाडोक उत्पन्न करना आवश्यक है?
A
उत्तर
1
कोई यह आवश्यक नहीं है
11
वैसे वहाँ कुछ भी नहीं वास्तव में यह करने के लिए लिए मजबूर कर रहा है, लेकिन यह निश्चित रूप से अच्छी तरह से लिखा है, Javadocs मदद करता है कि लोगों के सामने ब्राउज़ कर सकते हैं अगर आप एक प्रयोग करने योग्य पुस्तकालय के रूप में अपने निर्माण कलाकृतियों वितरित करना चाहते हैं वे आपके जार भी डाउनलोड करते हैं।
3
नहीं। बिल्ड प्रक्रिया में आप जो करना चुनते हैं वह आपके (या ग्राहक) पर निर्भर करता है। कुछ बिल्ड सिस्टम में डिफ़ॉल्ट रूप से जावाडॉक पीढ़ी शामिल हो सकती है, लेकिन इसे अक्षम करना आसान होना चाहिए।
1
आप उल्लेख नहीं करते हैं कि यह एक वेब ऐप, या वितरण के लिए लाइब्रेरी के लिए एक बिल्ड है या नहीं। जैसा कि अन्य प्रतिलिपिओं ने उल्लेख किया है, यह वास्तव में जरूरी नहीं है, लेकिन आंतरिक रूप से बनाए रखा वेब ऐप और बाहरी रूप से वितरित पुस्तकालय दोनों के लिए, दस्तावेज (जावाडोक के रूप में) बेहद उपयोगी होगा।
0
यदि आपकी बिल्ड प्रक्रिया चींटी का उपयोग करती है, तो मैं कहूंगा कि यह आवश्यक नहीं हो सकता है, लेकिन ऐसा करना मुश्किल नहीं होना चाहिए। आप बस जावाडोक कार्य का उपयोग करते हैं, इसे उत्पन्न करते हैं, और इसके साथ किया जाता है।
1
बिलकुल नहीं।
यदि आपके कोड के अधिकांश उपयोगकर्ता सीधे जावा फाइलों तक पहुंचते हैं और आईडीई का उपयोग करते हैं, तो वे पहले ही कोड संपादक में होवर के माध्यम से अपने जावाडॉक्स पढ़ रहे हैं। यह उस संस्करण की तुलना में अधिक अद्यतित हो सकता है जो चेक-इन है या जो बनाया जा रहा है (जब तक कि आप निरंतर निर्माण नहीं करते)।
यदि आप ग्राहकों को अंतरिम संस्करणों का पर्दाफाश करते हैं (उदा।, आप एक ओपन सोर्स प्रोजेक्ट हैं), तो क्लास फाइलों के बजाए जावाडॉक्स प्रदान करने से आपको विशिष्ट अर्थशास्त्र में बाध्य किया जाता है। यह आपके एपीआई के बारे में कठोर नियंत्रण प्रदान करने के लिए समझ में आता है और आपके जावाडॉक्स अनिवार्य रूप से आपके एपीआई का वर्णन करते हैं।
यदि आप अपने सार्वजनिक इंटरफेस का उपयोग करके बाहरी नहीं चाहते हैं (उदा।, आप उन्हें भविष्य में प्लग-इन के लिए खोलते रहें), तो आप इसे रोक नहीं सकते हैं, लेकिन आप जावाडॉक्स प्रदान करके निश्चित रूप से इसे प्रोत्साहित करने से बच सकते हैं।
0
आप तय करते हैं कि यह आवश्यक है या नहीं। निजी तौर पर, मैं जेवाडोक और अन्य भारी रिपोर्ट उत्पन्न नहीं करता हूं (जो उत्पन्न करने के लिए थोड़ा महंगा है) प्रत्येक बिल्ड पर, मैं डेवलपर मशीनों पर निर्माण जारी रखना चाहता हूं और निरंतर एकीकरण इंजन जितनी जल्दी हो सके (निरंतर एकीकरण इंजन हालांकि स्रोत जार बनाता है और प्रकाशित करता है)। रिपोर्ट निर्माण पीढ़ी के निर्माण के दौरान किया जाता है।
0
क्या निर्माण प्रक्रिया के हिस्से के रूप में जावाडोक उत्पन्न करना आवश्यक है?
नहीं