डोजो जेएस लाइब्रेरी + जेएसडोक -> कोड को कैसे दस्तावेज़ित करें?

Question

मुझे आपसे पूछना अच्छा लगेगा कि डोजो विकसित करने वाले लोग दस्तावेज़ कैसे बनाते हैं?

रात के निर्माण से आप सभी टिप्पणियों के साथ असंपीड़ित जेएस फाइलें प्राप्त कर सकते हैं, और मुझे यकीन है कि कुछ प्रकार की दस्तावेज़िंग स्क्रिप्ट है जो कुछ एचटीएमएल या एक्सएमएल उत्पन्न करेगी।

मुझे लगता है कि वे jsdoc का उपयोग करते हैं क्योंकि यह उनके utils फ़ोल्डर में पाया जा सकता है, लेकिन मुझे इसका उपयोग करने के बारे में कोई जानकारी नहीं है। jsDoc टूलकिट मूल dojo फ़ाइलों की तुलना में /**commenting**/ नोटेशन का उपयोग करता है।

धन्यवाद अपने सभी मदद

Answer 1

के लिए यह एक कस्टम PHP पदव्याख्यायित्र और Drupal के साथ सभी पूर्ण हो जाएगा। यदि आप util/docscripts/README और util/jsdoc/INSTALL में देखते हैं तो आप दस्तावेज़ों को उत्पन्न करने के तरीके के बारे में सभी जानकारी प्राप्त कर सकते हैं।

यह jsdoc-toolkit या JSDoc से भिन्न है (जैसा कि आपने खोजा है)।

एफडब्ल्यूआईडब्ल्यू, मैं jsdoc-toolkit का उपयोग कर रहा हूं क्योंकि स्थिर HTML उत्पन्न करना बहुत आसान है और Google कोड पेज पर टैग के बारे में बहुत सारे दस्तावेज हैं।

इसके अलावा, बस स्पष्ट होने के लिए, मैं खुद डोजो विकसित नहीं करता हूं। मैं बस इसे काम पर बहुत उपयोग करता हूं।

Answer 2

"डोजो जेएसडोक" प्रक्रिया में दो भाग हैं। PHP में लिखा गया एक पार्सर है, जो सूचीबद्ध नामस्थानों की संपूर्णता के एक्सएमएल और/या जेसन उत्पन्न करता है (उपयोग/डॉक्सस्क्रिप्ट/मॉड्यूल में परिभाषित किया गया है, ताकि आप अपना नामस्थान जोड़ सकें। फ़ाइल के ऊपर मूल उपयोग निर्देश हैं "उत्पन्न करें। php ") और" jsdoc "नामक एक ड्रूपल भाग जो ड्रूपल मॉड्यूल/प्लगइन/जो भी हो।

इसका ड्रूपल पहलू सिर्फ इस डेटा के डोजो का मूल दृश्य है। एक अच्छी तरह से तैयार XSLT या जेसन पर पुनरावृत्ति करने और एचटीएमएल का उत्पादन करने के लिए कुछ भी वही काम करेगा, हालांकि इनमें से कोई भी डिफ़ॉल्ट रूप से प्रदान नहीं किया जाता है (योगदान से प्यार होगा!)। मैं खुद को ड्रूपल बिट से दूर शर्मिंदा करता हूं, हालांकि यह कुछ समय के लिए api.dojotoolkit.org पर चल रहा है।

डॉक्टर पार्सर का खुलासा किया गया है ताकि आप अपनी खुद की कस्टम आउटपुट लिखने के लिए अपनी निरीक्षण क्षमताओं का भी उपयोग कर सकें। मैं कॉमोडो .cix कोड को एक [बल्कि मैला] PHP फ़ाइल उपयोग/डॉक्सस्क्रिप्ट/makeCix.php में पूरा करने के लिए इसका उपयोग करता हूं, जो स्पेस से मेल खाने के लिए तैयार किए गए XML दस्तावेज़ में मिली जानकारी को डंप करता है। इसे किसी भी प्रकार के आउटपुट को उत्पन्न करने के लिए संशोधित किया जा सकता है जिसे आपने थोड़ा फाइनलिंग के साथ चुना था।

डॉक वाक्य रचना सभी शैली दिशानिर्देश पृष्ठ पर परिभाषित किया गया है: http://dojotoolkit.org/reference-guide/developer/styleguide.html