2013-10-29 16 views
11

मुझे सी # कोड का एक गुच्छा विरासत मिला है। कुछ विधि परिभाषाओं के लिए मुझे ///<exclude/> इसके सामने एकमात्र XMLDoc के रूप में मिलता है। मैंने Google के अर्थ की कोशिश की लेकिन सफल नहीं हुआ। क्या कोई कृपया बता सकता है कि इसका क्या अर्थ हो सकता है?"/// <exclude/>" का क्या अर्थ है?

उत्तर

14

कम से कम NDoc में, इसका मतलब है कि इस सदस्य के लिए XML दस्तावेज़ को बाहर रखा जाना चाहिए। documentation से:

<exclude/> टैग दस्तावेज़ से वर्तमान आइटम को बाहर करने के NDoc निर्देश देता है।

यह है कि क्या यह मूल रूप से NDoc विशेष था मेरे लिए स्पष्ट नहीं है, लेकिन यह भी सैंडकैसल द्वारा समर्थित होने की दिखाई देता है (कि यह Sandcastle XML comments guide में है)।

+0

@Hanky ​​웃 चालाकी: इस सवाल का जवाब करने के लिए: यह जॉन स्कीट (अवधि)! ;-) – Andreas

+0

मेरे पास कोई सबूत नहीं है कि यह प्रोजेक्ट एनडीओसी का उपयोग करता है। शायद बहुत पहले किसी ने एनडीओसी का उपयोग शुरू करने की कोशिश की थी। अगर इस बात का कोई अन्य ज्ञात उपयोग नहीं है, तो मैं जॉन का जवाब लेता हूं। धन्यवाद! – Andreas

2

Sandcastle Help File Builderdocumentation से:

एक नाम स्थान नाम स्थान सारांश संपत्ति के माध्यम से बाहर रखा गया है या एक आइटम बाहर रखा गया है, क्योंकि इसके एक्सएमएल टिप्पणियाँ एक < को बाहर/> टैग शामिल हैं। यह जानकारी एपीआई फ़िल्टर सेटिंग्स के साथ स्वचालित रूप से विलय हो जाती है। इन वस्तुओं को बदलने के लिए, आपको नेमस्पेस सारांश संपत्ति का उपयोग करने या आइटम की XML टिप्पणियों से टैग को हटाने की आवश्यकता होगी।

एक अधिकारी ने जबाब:

A way to exclude documentation?

और व्यवहार के बारे में अधिक जानकारी:

Problems with missing members and tag

+1

आपके उत्तर के लिए धन्यवाद। – Andreas

संबंधित मुद्दे