सैंडकासल संपत्ति सारांशों को दस्तावेज नहीं कर रहा है

Question

मैं आज हमारे लिए कुछ उपयोगी कार्यों और गुणों का एक एपीआई बनाने में सहायता के लिए हेल्पबिल्डर जीयूआई के साथ सैंडकास्टल का उपयोग कर रहा हूं। मैंने कई गुणों पर /// <summary> ... </summary शामिल किया है जहां मुझे लगा कि उन्हें अतिरिक्त दस्तावेज या उपयोग के उदाहरणों से लाभ होगा।

जब मैं आउटपुट फ़ाइल को chm में बनाता हूं, तो मुझे सारांश विवरण बिल्कुल नहीं दिखाई दे रहा है। सभी संपत्ति सदस्यों को सूचीबद्ध किया गया है, लेकिन उनके विवरण खाली हैं। मैंने प्रोजेक्ट का पुनर्निर्माण किया है, और SandCastle में कुछ अलग सेटिंग्स की कोशिश की है, लेकिन वे अभी भी दिखाई नहीं दे रहे हैं।

क्या कुछ स्पष्ट है जो मैं देख रहा हूं? क्या SandCastle संपत्ति सारांश नहीं पढ़ता है? या सारांशों को एक अलग खोजशब्द की आवश्यकता है?

Answer 1

सैंडकैसल Common Issues सहायता पृष्ठ से:

लापता प्रलेखन

डिफ़ॉल्ट रूप से, एक परियोजना की एक्सएमएल प्रलेखन के सभी में कोड टिप्पणियाँ नामक एक एकल फ़ाइल, comments.xml में होने की उम्मीद है। यदि आपके पास एकाधिक एक्सएमएल दस्तावेज फाइलें हैं तो उन्हें नाम के एक नए फ़ोल्डर में रखें, टिप्पणियां और sandcastle.config को इसके बजाय एक जंगली कार्ड का उपयोग करने के लिए समायोजित करें, जैसा कि निम्न उदाहरण में है।

<!-- Copy in comments --> 
<component type="Microsoft.Ddue.Tools.CopyFromIndexComponent" 
      assembly="%DXROOT%\ProductionTools\BuildComponents.dll"> 
    <index name="comments" value="/doc/members/member" 
     key="@name" cache="100"> 
    <data base="%SystemRoot%\Microsoft.NET\Framework\v2.0.50727" 
      recurse="false" files="*.xml" /> 

    <data files="Comments\*.xml" /> <!-- This line was modified --> 

    </index> 
    <copy name="comments" source="*" target="/document/comments" /> 
<components> 

अधिक जानकारी के लिए, this blog post देखें। यहां बताए अनुसार सिर्फ इसी परियोजना गुण सेट:

Answer 2

आप संकलन समय पर एक्सएमएल फ़ाइल प्रलेखन उत्पन्न करने के लिए दृश्य स्टूडियो बताने के लिए है http://msdn.microsoft.com/en-us/library/vstudio/x4sa0ak0(v=vs.100).aspx

उसके बाद, सैंडकैसल होगा उत्पादन में "सारांश" टिप्पणी " विवरण "कॉलम।

Answer 3

ऐसा लगता है कि एक और उत्तर पहले से ही काम करने के रूप में स्वीकार कर लिया गया था, लेकिन मैं अपना समाधान जोड़ने जा रहा हूं क्योंकि मेरे पास एक ही समस्या थी लेकिन किसी अन्य कारण से।

यदि आप उस XML फ़ाइल को खोलते हैं जिसका उपयोग आप अपने प्रलेखन स्रोत के रूप में कर रहे हैं, तो उस विधि/संपत्ति को नियंत्रित करें जिसे आपने टिप्पणियां लिखी हैं लेकिन आपके अंतिम sandcastle दस्तावेज़ में दिखाई नहीं दे रही है। आप संदेश देखते हैं:

बुरी तरह से गठित XML टिप्पणी सदस्य के लिए नजरअंदाज कर दिया "एम: ...

फिर, मेरे जैसे, तो आप शायद कुछ अक्षर हैं जो एक्सएमएल के बारे में भी खुश नहीं था शामिल मैं का इस्तेमाल किया।" & "एक टिप्पणी में, लेकिन यदि आप" < "या"> "का उपयोग करते हैं तो एक्सएमएल आपको चिल्लाएगा। अपनी टिप्पणी को ठीक करें और आपको जाने के लिए अच्छा होना चाहिए!