डॉक्सिजन बनाम जावाडोक

Question

मुझे सीएसीएम में एक लेख से एहसास हुआ कि डॉक्सिजन जावा (और कई अन्य भाषाओं) के साथ भी काम करता है। लेकिन जावा पहले से ही जावाडोक उपकरण है। क्या कोई समझा सकता है कि किसी भी दृष्टिकोण के पेशेवर और विपक्ष क्या हैं? क्या वे पारस्परिक रूप से अनन्य हैं? क्या Doxygen के लिए एक मेवेन प्लगइन है?

Answer 1

डॉक्सीजन में कई विशेषताएं हैं जो जावाडॉक ऑफ़र नहीं करती है, उदा। पदानुक्रमों और सहयोग संदर्भ के लिए कक्षा आरेख, अधिक सारांश पृष्ठ, वैकल्पिक स्रोत-कोड ब्राउज़िंग (दस्तावेज़ीकरण के साथ क्रॉस-लिंक्ड), अतिरिक्त टैग समर्थन जैसे कि @ टोडो एक अलग पृष्ठ पर और यह टीएक्स और पीडीएफ प्रारूप में आउटपुट उत्पन्न कर सकता है यह बहुत सारे दृश्य अनुकूलन की अनुमति भी देता है।

चूंकि डॉक्सीजन मानक जावाडोक टैग का समर्थन करता है, इसलिए आप इस पर जावाडॉक टिप्पणियों के साथ किसी भी स्रोत कोड पर डॉक्सीजन चला सकते हैं। यह अक्सर जावाडोक के बिना स्रोत कोड पर चलाने के लिए भी समझ में आ सकता है क्योंकि आरेख और स्रोत कोड ब्राउज़िंग दस्तावेज़ के बिना भी कोड को समझने में मदद कर सकती है। और चूंकि JavaDoc उपकरण अज्ञात टैग को अनदेखा करता है, इसलिए आप JavaDoc पीढ़ी को तोड़ने के बिना अतिरिक्त डॉक्सीजन टैग का भी उपयोग कर सकते हैं।

यह सब करने के बाद मुझे यह स्वीकार करना होगा कि मैंने लंबे समय तक डॉक्सीजन का उपयोग नहीं किया है। मैं आज भी अपने आईडीई पर एक ही विज़ुअलाइज़ेशन प्रदान करने के लिए भारी निर्भर करता हूं और मैं आमतौर पर जावाडॉक को HTML पृष्ठों के रूप में नहीं पढ़ता लेकिन मेरे आईडीई में स्रोत फ़ाइलों को आयात करता हूं ताकि यह जावाडॉक फ्लाईआउट उत्पन्न कर सके और मैं परिभाषाओं पर जा सकूं। Doxygen क्या पेशकश करने के मुकाबले यह और भी शक्तिशाली है। यदि आप आईडीई के बाहर दस्तावेज़ीकरण करना चाहते हैं और गैर-जावा टूलिंग चलाने में प्रसन्न हैं तो डॉक्सिजन एक कोशिश के लायक है क्योंकि इसे आपके जावा कोड में किसी भी बदलाव की आवश्यकता नहीं है।

Answer 2

यदि आप जावा के लिए नए हैं तो मैं केवल जावा के साथ डॉक्सिजन का उपयोग करता हूं और आपने पहले डॉक्सिजन का उपयोग किया है, जो सीखने की वक्र को कम करता है जिसे आप जावाडोक के साथ अनुभव करेंगे। यदि आपने पहले डॉक्सिजन का उपयोग नहीं किया है, तो मैं जावाडोक के साथ रहूंगा, क्योंकि यह विशेष रूप से जावा के साथ दिमाग में डिज़ाइन किया गया था। यदि आप किसी एक को नहीं जानते हैं, और आप जावा + करते समय सी ++ (या अन्य समर्थित भाषाओं) में काम करते हैं, तो डॉक्सिजन एक अच्छी पसंद है, क्योंकि आप इसे दोनों भाषाओं के लिए उपयोग करने में सक्षम होंगे।

दोनों टूल समान सुविधा सेट के साथ उपयोग करने में आसान हैं। नेटबीन और ग्रहण के लिए प्लगइन (या पूर्व-निर्मित) दोनों में दस्तावेज़ उत्पन्न करने के लिए इसे और भी तेज बनाते हैं। प्रत्येक द्वारा उपयोग की जाने वाली टिप्पणी शैली में बहुत अधिक ओवरलैप है, लेकिन वे बिल्कुल समान नहीं हैं, इसलिए उन्हें एक साथ जोड़ना मुश्किल होगा (आपको दोनों के विवरणों को जानना होगा कोई भी विशेषताएं जो एक या दूसरे के लिए विशिष्ट हैं)। मैंने इसका कभी भी उपयोग नहीं किया है, लेकिन Maven plugin for Doxygen प्रतीत होता है।

Answer 3

मुझे यह तथ्य पसंद है कि डॉक्सिजन के साथ, आप दस्तावेज़ के रूप में उसी पृष्ठ पर प्रदर्शित क्लास आरेख प्राप्त कर सकते हैं। साथ ही, मुझे यह तथ्य पसंद है कि यदि आवश्यक हो तो यह आपको सीधे स्रोत कोड से लिंक करता है। मुझे पता नहीं है कि जावास्वाक में ये विशेषताएं हैं या नहीं।

Answer 4

जावाडॉक्स का एक बड़ा फायदा यह है कि वे बस काम करते हैं। उन्हें बनाने और देखने के लिए आवश्यक सब कुछ जेडीके में शामिल है जिसे आपको पहले से ही अपने कार्यक्रमों को संकलित करने के लिए स्थापित करने की आवश्यकता है।

दूसरी ओर, डॉक्सिजन स्थापित करने और सही तरीके से काम करने के लिए दर्द हो सकता है। लेकिन अगर यह सही तरीके से स्थापित किया गया है तो यह पीडीएफ, आरटीएफ, और डॉकबुक, साथ ही एचटीएमएल उत्पन्न करने में सक्षम होना चाहिए। HTMLDux के रूप में डिफ़ॉल्ट रूप से HTML को व्यवस्थित नहीं किया गया है क्योंकि index.html डिफ़ॉल्ट रूप से एक खाली पृष्ठ लाता है। इसके अलावा, इनलाइन कक्षाओं और स्थिर सदस्यों को दस्तावेजों में शामिल होने के लिए विशेष झंडे की आवश्यकता हो सकती है, और यदि आप एक पीडीएफ उत्पन्न करना चाहते हैं तो आपको लिनक्स के वितरण के परेशानियों से निपटना पड़ सकता है, जिसमें आवश्यक पीडीएफएलएक्सएक्स कमांड नहीं है (उदाहरण के लिए उबंटू/मिंट हाल ही में समस्याएं) इसलिए यदि आप इसे इंस्टॉल करते हैं और इसे चलाते हैं तो आपको एक साधारण प्रोग्राम के साथ भी त्रुटियों से भरा स्क्रीन मिल सकती है। जब आप एपीआई स्थापित करते हैं तो स्वचालित रूप से जावाडोक प्राप्त करने की आसानी की तुलना में, डॉक्सिजन सेटअप एक दुखी अनुभव हो सकता है।एक बार जब आप बाधाओं को दूर कर लेते हैं, तो यह सिर्फ जावा से अधिक परियोजनाओं से निपटने में अधिक लचीला होना चाहिए।