Cómo hacer referencia a un miembro de indexador de una clase en C# Comentarios

Question

Con el fin de hacer referencia a un miembro de una clase de comentarios/documentación XML, usted tiene que utilizar la siguiente etiqueta:

<see cref="member"/> 

Es mejor explicado here .

¿Cómo se hace referencia a un indexador ?

Es decir, un miembro como éste:

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

Gracias de antemano.

Answer 1

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

Answer 2

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

Answer 3

En general, con el fin de averiguar, cómo hacer referencia a cualquier miembro en sus comentarios, encontrar el miembro en su archivo de documentación XML para el montaje. Se crea en cada construcción. Con la única excepción de la referencia genéricos miembro se puede tomar desde aquí:

</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> 
    ... 

Por desgracia, los formatos de definición genéricos no parecen ser compatibles entre el archivo de documentación y las etiquetas CREF. Mientras que en el archivo XML, los genéricos se ven así:

<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> 
    ... 

La etiqueta cref les espera en uno de los siguientes formatos:

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

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

Answer 4

que he tenido la misma pregunta, pero con un genérica Propiedad Dictionary.Item (TKey). El answer by leppie

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

y la additional link by ICR (por desgracia no puedo encontrar el "mscorlib.xml")

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

me ayudó.

Pero the answer by user492238
(lo sé, lo debe comentar directamente su respuesta. Pero ya que soy nuevo y este es mi primer post, por favor vaya fácil en mí, porque no me está permitido hacer comentarios debido a mi baja reputación.)

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

dio como resultado sólo en, texto negro liso, con lo que sólo los segundos muestra etiqueta firma <> como se da "hard-coded".

he encontrado la solución en la página de MSDN de usar comillas invertidas (`) para los genéricos y tiene un total de referencias ("Colory") a la clase y la propiedad dentro de mi XMLDoc:

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

Dictionary<TKey, TValue>.this[TKey] 

Answer 5

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

según lo propuesto here.