के साथ डॉक-ओ-मैटिक (एक्सप्रेस) का उपयोग करना मैं डेल्फी स्रोत कोड दस्तावेज़ उत्पन्न करने के लिए एक टूल की तलाश में हूं, और मैं Doc-O-Matic एक्सप्रेस (जो मुफ़्त है) को आजमाने का प्रयास करना चाहता हूं। डेल्फी स्रोत कोड (डॉक-ओ-मैटिक प्रोजेक्ट्स, पसंदीदा डॉकब्लॉक स्टाइल, पूर्ण डॉकब्लॉक सिंटैक्स इत्यादि) को दस्तावेज करने के लिए शुरुआती लोगों के लिए डॉक-ओ-मैटिक एक्सप्रेस का उपयोग करने के लिए शुरुआती लोगों के लिए कोई दिशानिर्देश हैं?डेल्फी
इस page में आपको एक दस्तावेज़ मिल सकता है जो आपके लिए उपयोगी हो सकता है Delphi Documentation Guidelines। मैंने इस project में अपने स्रोत कोड को दस्तावेज़ित करने के लिए इस दिशानिर्देशों का उपयोग किया।
अभी डॉक-ओ-मैटिक सेटिंग्स से परेशान न हों। एक्सप्रेस संस्करण केवल कमांड लाइन है।
डॉक्टर-o-matic टिप्पणी सत्यापित करना (एक डिफ़ॉल्ट परियोजना शुरू करने के लिए पर्याप्त है) जावाडॉक और एक्सएमएल डॉक का समर्थन करें (या यहां तक कि देशी टिप्पणियों की तरह)। यह उपकरण केवल तभी मदद करेगा जब आपका कोड पहले ही टिप्पणी कर रहा हो, या यदि आप सीधे अपने आईडीई के अंदर टिप्पणी करना चाहते हैं।
आप XML दस्तावेज़ या JavaDoc, डॉक्टर-ओ-मैटिक दोनों समान रूप से अच्छी तरह से का समर्थन करता है की तरह है और सभी तीन शैलियों समर्थित हैं जब स्रोत लिख एकीकृत संपादक वापस के स्रोत के माध्यम से टिप्पणी है।
केवल गैर-वाणिज्यिक उपयोग के लिए नि: शुल्क। –
एक उपकरण के रूप में डॉक्टर-ओ-मैटिक वास्तव में बहुत अच्छा है लेकिन अंत में, आपके दस्तावेज़ की गुणवत्ता उतनी ही अच्छी है जितनी आपने अपने कोड पर टिप्पणी करने के प्रयास में उतनी ही अच्छी है। –
आप डेल्फीकोड टोडोक (डेल्फी के साथ लिखे गए ओपनसोर्स सॉफ़्टवेयर) का प्रयास कर सकते हैं। पहली परियोजना बनाना सेकंड का मामला है। इसके बाद, यदि आपको अधिक 'पेशेवर' विशेषताओं की आवश्यकता है, तो डॉक-ओ-मैटिक (जो बहुत शक्तिशाली है) आज़माएं। http://dephicodetodoc.sourceforge.net/ – TridenT