Doxygen 1.8.5

Doxygen - विकासकर्ताहरूको लागि अन्तिम दस्तावेजीकरण उपकरण

एक विकासकर्ताको रूपमा, तपाइँलाई थाहा छ तपाइँको कोडको लागि स्पष्ट र संक्षिप्त कागजात हुनु कत्तिको महत्त्वपूर्ण छ। उचित कागजात बिना, तपाईंको कोडबेसको संरचना बुझ्न गाह्रो हुन सक्छ, जसले भ्रम र त्रुटिहरू निम्त्याउँछ। त्यहि ठाउँमा Doxygen आउँछ - एक शक्तिशाली उपकरण जसले तपाईंको स्रोत फाइलहरूबाट अन-लाइन कागजात ब्राउजरहरू र अफ-लाइन सन्दर्भ पुस्तिकाहरू उत्पन्न गर्न सक्छ।

Doxygen एक नि:शुल्क र खुला-स्रोत सफ्टवेयर हो जुन 1997 देखि छ। यो यसको प्रयोगमा सहजता, लचिलोपन र शक्तिशाली सुविधाहरूको कारण विकासकर्ताहरू बीचको सबैभन्दा लोकप्रिय दस्तावेजीकरण उपकरणहरू मध्ये एक भएको छ। Doxygen को साथ, तपाईं सजिलै संग आफ्नो परियोजनाहरु को लागी पेशेवर देखिने कागजातहरु आफैले लेख्न घण्टा खर्च नगरी बनाउन सक्नुहुन्छ।

Doxygen को मुख्य विशेषताहरु मध्ये एक तपाईको स्रोत फाइलहरु बाट सीधा कागजात निकाल्ने क्षमता हो। यसको मतलब तपाईंले छुट्टै कागजात फाइलहरू लेख्नु पर्दैन वा तिनीहरूलाई तपाईंको कोडबेसबाट अलग राख्नुपर्छ। यसको सट्टा, तपाइँ केवल Doxygen ले पहिचान गर्ने विशेष ट्यागहरू प्रयोग गरेर तपाइँको स्रोत फाइलहरूमा टिप्पणीहरू थप्नुहोस्।

यी ट्यागहरूले तपाइँलाई तपाइँको कोडका विभिन्न पक्षहरू जस्तै प्रकार्यहरू, कक्षाहरू, चरहरू, र थप कागजात गर्न अनुमति दिन्छ। तपाईले प्यारामिटरहरू, रिटर्न मानहरू, प्रकार्यहरू वा विधिहरू द्वारा फ्याँकिएका अपवादहरू आदि बारे जानकारी पनि समावेश गर्न सक्नुहुन्छ, यसले अन्य विकासकर्ताहरू (वा आफैलाई पनि) कोडले कसरी काम गर्छ भनेर बुझ्न सजिलो बनाउँदछ।

एकचोटि तपाईंले आफ्ना स्रोत फाइलहरूमा यी टिप्पणीहरू थप्नुभएपछि (जुन सुरुमा कठिन लाग्न सक्छ तर स्प्याडहरूमा भुक्तान हुन्छ), Doxygen चलाउँदा प्रत्येक प्रकार्य/वर्ग/चर/इत्यादि बारे सबै सान्दर्भिक जानकारीको साथ HTML-आधारित ब्राउजर इन्टरफेस उत्पन्न हुनेछ। , कुनै पनि सम्बद्ध रेखाचित्रहरू जस्तै विरासतका रूखहरू वा सहयोग रेखाचित्रहरू सहित।

तर के हुन्छ यदि कोडका केही अंशहरू कागजात गरिएका छैनन् भने? समस्या छैन! Doxygen को कन्फिगरेसन विकल्पहरू (जुन फराकिलो छन्) को साथ, तपाइँ यसलाई जे भए पनि जेनेरेट गरिएको आउटपुटमा कुन कागजात नभएका भागहरू समावेश गर्नुपर्छ भनेर बताउन सक्नुहुन्छ - यस तरिकाले ब्राउज गर्दा केही क्षेत्रहरूको बारेमा ज्ञानमा अन्तरहरू भए पनि तिनीहरू दृश्यबाट पूर्ण रूपमा हराउने छैनन्। डाउन-द-लाइनमा पछि कागजातहरू उत्पन्न गरियो!

Doxygen को अर्को उत्कृष्ट विशेषता भनेको RTF (MS-Word), PostScript/PDFs/hyperlinked PDFs/compressed HTML/Unix man pages आदि जस्ता विभिन्न ढाँचाहरूमा आउटपुट उत्पादन गर्नको लागि समर्थन हो। यसको मतलब यो हो कि कुनै पनि ढाँचा जोसुकैले आफ्नो कागजातलाई प्राथमिकता दिन्छ। तिनीहरूले सम्भवतः यहाँ उपयुक्त केहि पाउनुहुनेछ!

पहिले उल्लेख गरिएको समावेशी निर्भरता ग्राफहरू अर्को उत्कृष्ट विशेषता हुन्: यसले देखाउँदछ कि परियोजना भित्रका विभिन्न तत्वहरू कसरी दृश्यात्मक रूपमा एकसाथ सम्बन्धित छन् ताकि प्रयोगकर्ताहरूले द्रुत रूपमा एक विचार प्राप्त गर्छन् जहाँ सबै चीजहरू प्रत्येक रेखालाई पहिले नै नपढाइकन ठाउँमा फिट हुन्छ; यसले विशेष गरी धेरै अन्तरनिर्भर कम्पोनेन्टहरू भएका ठूला परियोजनाहरूसँग काम गर्दा समय बचत गर्छ।

इनहेरिटेन्स रेखाचित्रहरूले वर्ग/इन्टरफेस/इत्यादि बीचको सम्बन्ध देखाएर समान फाइदाहरू प्रदान गर्दछ, जबकि सहयोग रेखाचित्रहरूले समान वर्गहरू/इन्टरफेसहरू/इत्यादि भित्रका विभिन्न वस्तुहरू बीचको अन्तरक्रिया देखाउँछन्। सबै तीन प्रकारले धेरै मोड्युलहरूमा छरिएका सन्दर्भ बाहिरका स्निपेटहरू बुझ्न मद्दत गर्दछ। /files/folders/etc..

समग्रमा त्यसोभए हामी उच्च गुणस्तरका कागजातहरू छिटो र प्रभावकारी रूपमा उत्पादन गर्न सक्ने प्रयोग गर्न सजिलो तर शक्तिशाली उपकरण खोज्दै हुनुहुन्छ भने DoxyGen प्रयास गर्न सिफारिस गर्छौं!