जावाडोक

Question

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

मेरा सवाल यह है कि, क्या लोग आम तौर पर परियोजना के उच्च स्तरीय दृश्य (उदा। आर्किटेक्चर, डिज़ाइन फैसले इत्यादि) को दस्तावेज करने के लिए जावाडॉक्स का उपयोग करते हैं, या इस तरह की जानकारी सबसे अच्छी तरह से विकी में कहती है?

Answer 1

यह इस बात पर निर्भर करता है कि आपके दर्शक कौन हैं।

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

चाहे आप दस्तावेज़ीकरण को विकी में या पीडीएफ में रखना चाहते हैं, फिर भी यह दर्शकों पर निर्भर करता है। यदि विकी के लिए एकमात्र कारण दस्तावेज के HTML प्रतिनिधित्व का सामना करना पड़ता है, तो दस्तावेज़ के समान कुछ उपयोग करने से दस्तावेज़ों को समान दस्तावेज़ीकरण के पीडीएफ प्रस्तुतिकरण उत्पन्न करने की क्षमता के अतिरिक्त लाभ के साथ प्रदान किया जा सकता है। यदि आपके पास वास्तव में एक सक्रिय समुदाय है, तो विकी अजनबियों को आपके दस्तावेज़ों को संशोधित करने की अनुमति देने की क्षमता में चमकता है।

निर्धारित करें कि उत्पादों की ताकत आपकी आवश्यकताओं के अनुरूप हैं, और यदि वे करते हैं, तो यह सही विकल्प है।

Answer 2

जेवाडोक एपीआई स्तर के दस्तावेज उत्पन्न करने के लिए बहुत अच्छा है। मैं अपने उच्च स्तरीय दस्तावेज के लिए विकी का उपयोग करता हूं। मैं अपने विकी के रूप में confluence का उपयोग करता हूं और कुछ प्लगइन्स हैं जिनका उपयोग आप वास्तुशिल्प आरेखों के लिए कर सकते हैं।