sandcastle

Question

के साथ बाह्य डीएल को दस्तावेज करना मैं वर्तमान में एक एप्लीकेशन विकसित कर रहा हूं, जिसके लिए बाहरी डीएल की आवश्यकता है जिसे मैं नियंत्रित नहीं करता हूं। मैं इन वर्गों के लिए प्रलेखन जोड़ना चाहता हूं, ताकि अन्य समझ सकें कि मैं कुछ बाहरी कॉल क्यों कर रहा हूं, मैं इन बाहरी DLL फ़ाइलों को बना रहा हूं।

प्रलेखन स्रोतों में बाहरी DLL फ़ाइलों को जोड़ना वास्तव में कक्षाओं को लॉग करता है, लेकिन सभी सारांश और अन्य जानकारी अनुपलब्ध है। क्या इन फ़ाइलों को दस्तावेज करना संभव है (अधिमानतः बिना किसी परियोजना के असेंबली को पुन: संकलित/पुनर्निर्मित किए बिना), इसलिए मैं संबंधित HTML दस्तावेज़ को sandcastle के साथ उत्पन्न कर सकता हूं?

मैंने सैंडकास्टल्स कार्यशील निर्देशिका को सक्षम रखने की कोशिश की है, यह देखने के लिए कि .xml फ़ाइलें (जो कि मैंने अपनी अन्य परियोजनाओं से कॉपी की थी) किसी भी तरह से इस निर्देशिका में उत्पन्न और रखी गई थीं। यह मामला प्रतीत नहीं होता है, कोई भी फाइल जेनरेट नहीं होती है, और यह सीधे HTML फ़ाइलों को उत्पन्न करने के लिए जाती है।

Answer 1

जहाँ तक मैं एक बाहरी DLL उपयोग के मामले के लिए दस्तावेज़ बनाने के बारे में अपने प्रश्न को समझने के रूप में मैं दो संभव तरीके है कि आप जा सकते हैं:

• जोड़ें "लापता" नोट्स बाहरी DLL के सभी मदों के लिए है कि आप शायद या/और
• दस्तावेज करना चाहते हैं, अपने स्वयं के प्रोग्राम दस्तावेज़ों में वैचारिक विषय जोड़ें।

मेरे नमूना समाधान WindowsApplication2 परियोजना एक सरल PDUNZDLL का उपयोग कर दो मान जोड़ने के लिए एक रूप है। एक Sandcastle मदद फ़ाइल निर्माता परियोजना "दस्तावेज़ीकरण 1" जोड़ा गया था और दो दस्तावेज़ीकरण स्रोत (इस चरण में एक्सएमएल टिप्पणी फ़ाइल के बिना, नीचे पहला स्नैपशॉट देखें)। आप जानते हैं - एक्सएमएल टिप्पणियों के बिना एक डीएलएल एक लाल गायब सारांश के परिणामस्वरूप है।

प्रस्तावित समाधान (1):

1. निम्नलिखित और यह नाम उसे .xml एक्सटेंशन जैसे के साथ विधानसभा के बाद की तरह एक खाली एक्सएमएल फ़ाइल बनाएँ टिप्पणियाँ PDUNZDLL.xml

   <?xml version="1.0"?> 
   <doc> 
       <assembly> 
       <name>PDUNZDLL</name> 
       </assembly> 
       <members> 
       </members> 
   </doc> 
   

2. सहेजें जैसे डीबग फ़ोल्डर में इस फाइल को D:\Visual-Studio-2015\Projects\WindowsApplication2\WindowsApplication2\bin\Debug

3. डबल क्लिक करें "प्रोजेक्ट गुण" (नीचे दूसरे स्नैपशॉट देखें)
4. घटक विन्यास संवाद में, जोड़ें " परियोजना के लिए IntelliSense घटक "।
5. "गुम टैग" का चयन करें और अपनी पसंद के लिए प्रोजेक्ट के गुम टैग गुणों को दिखाएं। यह बिल्ड को उन सभी वस्तुओं के लिए "अनुपलब्ध" नोट जोड़ने के लिए मजबूर करेगा जिन्हें आप दस्तावेज़ बनाना चाहते हैं।
6. प्रोजेक्ट बनाएं और आपको प्रोजेक्ट के आउटपुट फ़ोल्डर में असेंबली के नाम पर एक नई एक्सएमएल टिप्पणियां फ़ाइल मिल जाएगी। D:\Visual-Studio-2015\Projects\WindowsApplication2\Documentation1\Help
7. XML स्नैपशॉट में दिखाए गए प्रत्येक टिप्पणी के लिए टिप्पणियों को जोड़ने के लिए XML टिप्पणियों फ़ाइल में <member> तत्वों को संपादित करें।

जब आप पूरा कर लें, तो अपनी मूल प्लेसहोल्डर फ़ाइल को बदलें।D:\Visual-Studio-2015\Projects\WindowsApplication2\WindowsApplication2\bin\Debug\PDUNZDLL.xml आपके संपादित टिप्पणियों के साथ निर्माण से उत्पन्न एक के साथ। अपने प्रलेखन परियोजना को पुनर्निर्माण करें।

यह निश्चित रूप से अनुप्रयोगों के लिए किसी भी मदद संलेखन के रूप में उपभोग करने वाला समय है। और यह वास्तव में डीएलएल डेवलपर का काम था।

प्रस्तावित समाधान (2):

अपने लाइनों "... के बीच पढ़ना ताकि दूसरों को समझ सकता हूँ कारण है कि मैं कुछ कॉल मैं इन बाहरी DLL फ़ाइलों के लिए बना रही हूँ बना रही हूँ । " मुझे अपने स्वयं के कार्यक्रम में एक पूरक दस्तावेज जोड़ने के सुझाव के लिए प्रेरित करता है।

तो, मेरा मतलब है कि आप बाहरी डीएलएल फ़ाइलों की सुविधाओं को कैसे कॉल करते हैं, यह बताते हुए वैचारिक विषयों को जोड़ना है।

मैं "प्रलेखन सूत्रों का कहना है" के अंतर्गत DLL हटा दिया, एक नया फ़ोल्डर "ExternalDLL" जोड़ा, एक नया आइटम वैचारिक जोड़ा गया है और पूर्वाभ्यास, डबल क्लिक करें समाधान एक्सप्लोरर में ContentLayout.content, और सामग्री के लिए सभी कदम किया लेआउट, प्रलेखन प्रोजेक्ट को पुनर्निर्माण करें जिसके परिणामस्वरूप नीचे दी गई तीसरी स्नैपशॉट में दिखाए गए एक सहायता फ़ाइल में (पृष्ठभूमि जानकारी भी देखें)।

मुबारक मदद संलेखन!