सी # में एक वर्ग का एक इंडेक्सर सदस्य संदर्भ के लिए कैसे टिप्पणी

Question

आदेश एक्सएमएल टिप्पणी/दस्तावेज में एक वर्ग के एक सदस्य को संदर्भित करने में, आपको निम्न टैग का उपयोग करने के लिए है ।

आप सूचकांक का संदर्भ कैसे देते हैं?

मेरा मतलब है, इस तरह के एक सदस्य:

internal object this[ int index ] { 
    ... 
} 

अग्रिम धन्यवाद।

Answer 1

<see cref="P:System.Collections.ArrayList.Item(System.Int32)" /> 

Answer 2

<see cref="this[int]" /> 

Answer 3

सामान्य तौर पर, आदेश पता लगाने के लिए, अपनी टिप्पणी में किसी भी सदस्य को संदर्भित करने के लिए कैसे, विधानसभा के लिए अपने XML प्रलेखन फ़ाइल में सदस्य को खोजने में। यह प्रत्येक निर्माण पर बनाया गया है। जेनरिक का केवल अपवाद के साथ सदस्य संदर्भ यहाँ से लिया जा सकता है:

</member> 
<member name="P:My.Namespace.Class1.Item(System.String)"> 
    <summary> 
     retrieve a single item of the given name from this instance 
    </summary> 
    <param name="name">name of the item</param> 
    <returns>the item</returns> 
</member> 
<member name="M:My.Namespace.Class1.Function1(System.Int32[])"> 
    <summary> 
    ... 

दुर्भाग्य से, सामान्य परिभाषा प्रारूपों प्रलेखन फ़ाइल और cref टैग के बीच संगत नहीं होने लगते हैं। जबकि एक्सएमएल फ़ाइल में, जेनरिक कि तरह लग रहे:

<member name="M:My.Namespace.Class1.Get``1(System.String)"> 
    <summary> 
    retrieve an named item of the given type 
    </summary> 
    <typeparam name="T">the type of the item to retrieve</typeparam> 
    ... 

cref टैग उन्हें निम्न स्वरूपों में से एक में उम्मीद:

/// <seealso cref="M:My.Namespace.Class1.Get{T}(System.String)"/> 

/// <seealso cref="M:My.Namespace.Class1.Get&lt;T>(System.String)"/> 

Answer 4

मैं एक ही सवाल किया है, लेकिन एक सामान्य के साथ शब्दकोश। इटिम (टीकेई) संपत्ति। answer by leppie

<see cref="P:System.Collections.ArrayList.Item(System.Int32)" />

और additional link by ICR (दुर्भाग्य से मैं "mscorlib.xml" नहीं मिल सकता है)

MSDN: Processing the XML File (C# Programming Guide)

मुझे बाहर में मदद की।

लेकिन the answer by user492238
(मुझे पता है, मैं सीधे अपने जवाब टिप्पणी करना चाहिए। लेकिन चूंकि मैं नया हूँ और यह मेरा पहली पोस्ट है, मुझ पर आसान जाना कृपया क्योंकि मैं अपने कम प्रतिष्ठा की वजह से टिप्पणी करने की अनुमति नहीं कर रहा हूँ।)

<seealso cref="M:My.Namespace.Class1.Get{T}(System.String)"/>
<seealso cref="M:My.Namespace.Class1.Get&lt;T>(System.String)"/>

केवल सादे, काले पाठ, जिसके तहत केवल कुछ सेकंड टैग संकेत <> "हार्ड-कोडेड" के रूप में दिया चलता में हुई।

मैं MSDN पृष्ठ पर समाधान नहीं मिला बैकटिक (`) जेनरिक के लिए उपयोग करने के लिए और मेरे xmlDoc के भीतर पूर्ण (" colory ") वर्ग और संपत्ति के लिए संदर्भ मिल गया:

<see cref="P:System.Collections.Generic.Dictionary`2.Item(`0)" /> 

Dictionary<TKey, TValue>.this[TKey] 

Answer 5

<see cref="ReadOnlyCollection{T}.this[int]" /> 

प्रस्तावित here के रूप में।