के समान डेल्फी के लिए कोड प्रलेखन मुझे डेल्फी कोड के लिए जावाडोक या सी # एक्सएमएल दस्तावेज़ के समान कोड दस्तावेज़ टूल की आवश्यकता है। सबसे अच्छा उपकरण क्या है? मैं एक तकनीक पसंद करता हूं, जो भविष्य में माइक्रोसॉफ़्ट सैंडकासल परियोजना के अनुकूल है।जेवाडोक या सी # एक्सएमएल दस्तावेज़
डेल्फी में लिखे गए एक ओपन सोर्स टूल SynProject पर एक नज़र डालें।
यह एक पूर्ण प्रलेखन वर्कफ़्लो को संभालने के लिए डिज़ाइन किया गया था, विनिर्देशों से रिलीज नोट्स, परीक्षण, वास्तुकला और डिज़ाइन सहित; और निश्चित रूप से मौजूदा डेल्फी स्रोत कोड से आर्किटेक्चर दस्तावेज उत्पन्न करने के लिए एक एकीकृत डेल्फी पार्सर है।
आर्किटेक्चर दस्तावेज़ के लिए, स्रोत कोड टिप्पणियां निकाल सकता है (एला पासडोक) फिर इस टेक्स्ट को मुख्य आर्किटेक्चर दस्तावेज़ (कक्षा पदानुक्रम आरेखों और इकाई निर्भरताओं के साथ) में एम्बेड करें।
आप समर्पित टेक्स्ट एडिटर में विकी-जैसी वाक्यविन्यास का उपयोग करके एक सादा पाठ फ़ाइल लिखते हैं, तो SynProject इसके द्वारा अच्छी तरह से बनाए गए वर्ड दस्तावेज़ बनाता है। कुछ विज़ार्ड सामग्री तक पहुंचने के लिए उपलब्ध हैं। लेकिन चूंकि इसे सादा फ़ाइल के रूप में संग्रहीत किया जाता है, इसलिए कई प्रोग्रामर किसी भी एससीएम उपकरण (एसवीएन, जीवाश्म ...) का उपयोग करके उस पर लिख सकते हैं।
उदाहरण के लिए, मैं वर्तमान में एक बड़े और पुराने डेल्फी एप्लिकेशन (डेल्फी 5 और 6 में लिखे गए कोड की लगभग 2,000,000 लाइनों) के लिए रखरखाव दस्तावेज लिखने के लिए इसका उपयोग करता हूं, बिना किसी पूर्व दस्तावेज के। आप कोड में किए गए परिवर्तनों का वर्णन करते हैं (इकाई/वर्ग/विधि उद्धृत करके), तो उपकरण उन संशोधनों को प्रतिबिंबित करने और उनका पता लगाने के लिए सभी दस्तावेज अपडेट करेगा। SynProject को कुछ बहुत ही "नाजुक" विनियमन नियमों (आईईसी 62304) के अनुरूप होने के लिए डिज़ाइन किया गया था, लेकिन इसका उपयोग अपने अद्वितीय "फ्लैट" डिज़ाइन के कारण किसी भी प्रोजेक्ट के लिए किया जा सकता है।
नोट: मैं इस प्रश्न के बाद इसे लंबे समय से पोस्ट कर रहा हूं, क्योंकि इस समय SynProject मौजूद नहीं था, और यह देखने लायक हो सकता है। यह धागा has been defined as a reference for that question।
डेल्फी + JavaDoc = DelphiCodeToDoc
जहां तक मुझे पता है कर रहा हूँ, वहाँ कोई उपकरण माइक्रोसॉफ्ट सैंडकैसल के साथ आसानी से संगत है - कम से कम जब तक किसी को वास्तव में एक लिखने के लिए परेशान, किसी मौजूदा संशोधित करने के लिए, या बनाने के लिए आउटपुट को सही ढंग से बदलने के लिए एक टूलचेन।
मैंने व्यक्तिगत सफलतापूर्वक PasDoc का उपयोग सफलतापूर्वक किया है। मैं नवीनतम एसवीएन संस्करण बनाने की सलाह देता हूं, क्योंकि वर्तमान रिलीज कभी-कभी जटिल इंटरफ़ेस परिभाषाओं पर क्रैक करता है।
मैं PasDoc का भी उपयोग करता हूं और इसे क्रूज़ कंट्रोल, एफडब्ल्यूआईडब्ल्यू द्वारा बुलाए गए एंट बिल्ड स्क्रिप्ट से चलाता हूं। –
रिचर्ड, यह एक अच्छा मुद्दा है क्योंकि यह दिखाता है कि इसे एक निर्माण के माध्यम से स्वचालित किया जा सकता है। – Pauk
मैं इसे पिछले पांच या इतने सालों में सफलतापूर्वक उपयोग करता हूं, फिर भी एक महान और सरल समाधान। – mjn
बहुत अच्छा काम करता है (और सी और सी ++ प्रोजेक्ट के लिए प्रलेखन जैसा दिखता है हम भी उपयोग करते हैं) – sdu
यह मेरे लिए पहले अस्पष्ट था, इसलिए मैं दूसरों को एक टिप्पणी जोड़ना चाहता था कि ये दोनों उत्पाद एक साथ काम करते हैं। Pas2Dox Doxygen के लिए एक ऐड-ऑन प्रतीत होता है, जिसमें डेल्फी समर्थन शामिल है। –
सैंडकैसल ताकि इसे उत्पन्न करने के लिए विधानसभाओं के लिए उपयोग होने की जरूरत है प्रलेखन जिसका अर्थ है कि यह नेट भाषाओं के लिए लागू है (हालांकि मुझे यकीन है कि सक्षम डेल्फी नहीं कर रहा हूँ है,। नेट)। हालांकि, डेल्फी 2007 और 200 9 में एक इनलाइन एक्सएमएल दस्तावेज सी # के समान ही है। जब आप प्रोजेक्ट विकल्पों में 'जेनरेट एक्सएमएल दस्तावेज' विकल्प को स्विच करते हैं, तो यह इन टिप्पणियों के आधार पर एक्सएमएल दस्तावेज तैयार करेगा। एक्सएसएलटी का उपयोग तब भी किया जा सकता है जो आपको आवश्यक दस्तावेज प्रारूप उत्पन्न करने के लिए किया जा सकता है (यह मुश्किल है)।
डेल्फी 2005 के बाद से यह डेल्फी कंपाइलर में बनाया गया है। यह XMLDoc मानक का उपयोग करता है जो XML शैली टिप्पणियों का उपयोग करता है। जैसे सी # करता है, तो मुझे लगता है कि Sandcastle इसे संभाल सकता है। देखें http://dn.codegear.com/article/32770 और http://tondrej.blogspot.com/2006/03/xml-documentation-in-delphi-2006.html
भी देखें Documenting Delphi
डी 2006 एक्सएमएलडॉक जनरेटर पूरी तरह टूटा हुआ है। मैंने इसका इस्तेमाल करने की कोशिश की - सभी पैच के बाद काम नहीं करता है। –
DelphiCodeToDoc भी एक कमांड लाइन सतत एकीकरण उपकरण (उदाहरण के लिए) के साथ इसका इस्तेमाल करने के लिए है।
सवाल बहुत पुराना है, लेकिन मुझे आज भी यही समस्या थी और यह पोस्ट मिला।
/// <summary>
/// Summary of the function/class
/// </summary>
/// <param name="param1">Description of the parameter param1</param>
/// <param name="param2">Description of the parameter param2</param>
/// <param name="param3">Description of the parameter param3</param>
/// <returns>Description of the return value</returns>
function test(param1, param2, param3: string): string;
<summary> के लिए, वहाँ लाइनब्रेक अनुमति देने के लिए एक संभावना हो प्रतीत नहीं होता है: डेल्फी 2007 निम्नलिखित वाक्य रचना है, जो सी # दस्तावेजों के बराबर हो रहा है की अनुमति देता है। <br /> काम नहीं करता है।
< br/> आज़माएं –
मैंने कोशिश की और यह क्रैश हो गया और फ़ाइल में अज्ञात प्रक्रिया शामिल है। – awmross