Usando C # 's atributo XML comentario CREF con la sintaxis params

Question

En C #, que estoy tratando de utilizar para hacer referencia a una firma de método que contiene la palabra clave params. Sé que esto convierte la lista de parámetros de una matriz, pero yo ni siquiera puedo averiguar cómo hacer referencia a un array en un atributo CREF. Estoy encontrando nada en mis búsquedas y nadie que yo conozca tiene alguna idea, tampoco. El compilador está ahogando con los corchetes. He intentado todo tipo de combinaciones diferentes, se utilizan llaves, usando la clase Array, pero nada funciona. ¿Alguien sabe esto?

Answer 1

El ECMA 334 estándar PDF, Anexo E contiene una visión decente de comentarios de documentación XML. Puede descargar el estándar en:

http://www.ecma-international.org/publications/standards/Ecma-334.htm

En concreto, querrá el apartado E.3.1, comenzando en la página 496.

Contenidos similares también se encuentra en MSDN (MSDN aunque parece tener terribles navegación en este tema, por lo que es difícil encontrar las otras secciones):

http://msdn.microsoft.com/en-us/library/aa664787 (VS 0,71) .aspx

El equivalente a E.3.1:

http://msdn.microsoft.com/en-us/library/aa664807 (VS 0,71) .aspx

También puede encontrar documentación de Mono útil:

http://www.go-mono.com /docs/index.aspx?tlink=29@man%3amdoc(5)

specfically, la sección "CREF FORMATO" abarca las convenciones de cadenas de identificación.

Actualización del 05/23/2018

La dirección URL de la ECMA-334 PDF estándar por encima de los enlaces a la última edición de la norma. En el año 2009, que fue la cuarta edición de la norma. Sin embargo, a partir de diciembre de 2017, la 5ª edición está actualizada, y la sección E.3.1 de la cuarta edición se convirtió en la sección D.4.2 en la 5ª edición.

Las versiones anteriores del estándar ECMA-334 están disponibles para su descarga desde la página siguiente: https://www.ecma-international.org/publications/standards/Ecma-334-arch.htm

Answer 2

De acuerdo con la formato de cadena B.3.1 ID artículo, hace referencia a una matriz se hace con corchetes [] (con especificadores lowerbound:size opcional), pero si sólo desea hacer referencia a un array de un tipo determinado (o incluso una serie de objetos), no se puede simplemente escribir

<see cref="Object[]"/>

lugar, tiene que especificar que está haciendo una referencia de tipo con el prefijo T:, como

<see cref="T:Object[]"/>

Esto no parece aplicar al hacer referencia a una sobrecarga específica de un método, como

<seealso cref="String.Join(String, String[])"/>

Answer 3

Usted acaba de dejar de lado la palabra clave param y un puesto en el tipo de esta manera:

/// <summary>
/// <see cref="Method(string[])"/>
/// </summary>
public static void Main()
{
    Method("String1", "String2");
}

public static void Method(params string[] values)
{
    foreach (string value in values)
    {
        Console.WriteLine(value);
    }
}