Utilizzando attributi C # 's XML commento cref con la sintassi params

Question

In C #, sto cercando di usare fare riferimento a una firma del metodo che contiene la parola chiave params. So che converte l'elenco dei parametri di un array, ma non riesco nemmeno a capire come fare riferimento a una matrice in un attributo CREF. Sto trovando nulla nelle mie ricerche e nessuno so che ha qualche idea, neanche. Il compilatore sta soffocando sulle parentesi quadre. Ho provato tutti i tipi di combinazioni diverse, utilizzando parentesi graffe, utilizzando la classe Array, ma niente sta funzionando. Qualcuno sa questo?

Answer 1

L'ECMA 334 PDF standard, allegato E contiene una panoramica decente di commenti di documentazione XML. È possibile scaricare lo standard all'indirizzo:

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

In particolare, si vorrà sezione E.3.1, a partire da pagina 496.

Contenuti simili è anche a MSDN (anche se MSDN sembra avere terribili navigazione su questo argomento, il che rende difficile trovare le altre sezioni):

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

L'equivalente a E.3.1:

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

È inoltre possibile trovare la documentazione del Mono utili:

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

specfically, la sezione "CREF FORMAT" copre le convenzioni stringa ID.

Aggiornamento 2018/05/23

L'URL per l'ECMA-334 standard PDF sopra collegamenti alla ultima edizione dello standard. Nel 2009, che è stata la quarta edizione della norma. Tuttavia, a partire dal dicembre 2017, la 5 ° edizione è in corso, e la sezione E.3.1 dalla 4 ° edizione è diventata la sezione D.4.2 nella 5 ° edizione.

Le versioni precedenti dello standard ECMA-334 sono disponibili per il download dal seguente pagina: https://www.ecma-international.org/publications/standards/Ecma-334-arch.htm

Answer 2

Secondo il formato stringa B.3.1 ID articolo, fa riferimento a una matrice viene fatto con parentesi quadre [] (con prescrittori lowerbound:size opzionali), ma se si desidera solo per fare riferimento a una matrice di un certo tipo (o anche una matrice Object), non si può semplicemente scrivere

<see cref="Object[]"/>

invece è necessario specificare che stai facendo un riferimento di tipo con il prefisso T:, come

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

Questa non sembra applicarsi quando fa riferimento a un sovraccarico di specifica di un metodo, ad esempio

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

Answer 3

Hai appena lascia la parola chiave param e mettere nel tipo in questo modo:

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