Usando el atributo xml de credencial de comentario de C# con la sintaxis de parámetros

Question

En C#, trato de usar < vea cref = "blah"/> para hacer referencia a una firma de método que contiene la palabra clave params. Sé que esto convierte la lista de parámetros en una matriz, pero ni siquiera puedo averiguar cómo hacer referencia a una matriz en un atributo CREF. No encuentro nada en mis búsquedas y tampoco conozco a nadie. El compilador se está ahogando en los corchetes. He probado todo tipo de combinaciones diferentes, usando llaves, usando la clase Array, pero nada está funcionando. ¿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

Específicamente, usted querrá el apartado E.3.1, empezando en la página 496.

contenido similar está también 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.71).aspx

El equivalente a E.3.1:

http://msdn.microsoft.com/en-us/library/aa664807(VS.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" cubre las convenciones cadena de ID.

Answer 2

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); 
     } 
    } 

Answer 3

De acuerdo con el artículo B.3.1 ID string format, haciendo referencia a una matriz se hace con [corchetes] (con lowerbound:size especificadores opcional), pero si sólo desea hacer referencia a un array de un tipo determinado (o incluso una serie de objetos), que puede 't acaba de escribir

<see cref="Object[]"/>

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

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

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

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