En utilisant XML commentaire de C # CREF attribut avec la syntaxe params

Question

En C #, je suis en train d'utiliser pour faire référence à une signature de la méthode qui contient le mot-clé params. Je sais que cela convertit la liste des paramètres à un tableau, mais je ne peux même pas comprendre comment faire référence à un tableau dans un attribut CREF. Je trouve rien dans mes recherches et je ne connais personne a une idée, que ce soit. Le compilateur étouffe sur les crochets. J'ai essayé toutes sortes de combinaisons différentes, en utilisant des accolades, en utilisant la classe Array, mais rien ne fonctionne. Est-ce que quelqu'un sait cela?

Answer 1

Le ECMA 334 PDF standard, l'annexe E contient une vue d'ensemble décent de commentaires de documentation XML. Vous pouvez télécharger la norme à:

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

Plus précisément, vous voulez la section E.3.1, à partir de la page 496.

Contenu similaire est également à MSDN (bien que MSDN semble avoir de terribles navigation sur ce sujet, ce qui rend difficile de trouver les autres sections):

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

L'équivalent à E.3.1:

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

Vous pouvez également trouver la documentation utile Mono:

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

Specfically, la section "CREF FORMAT" couvre les conventions de chaîne d'identification.

Mise à jour 23/05/2018

L'URL de l'ECMA-334 standard PDF liens ci-dessus à la dernière édition de la norme. En 2009, ce fut la 4ème édition de la norme. Cependant, à partir de Décembre 2017, la 5ème édition est E.3.1 actuelle, et la section de la 4e édition est devenu l'article D.4.2 à la 5ème édition.

Les versions précédentes de la norme ECMA-334 sont disponibles pour téléchargement à partir de la page suivante: https://www.ecma-international.org/publications/standards/Ecma-334-arch.htm

Answer 2

Selon le format de chaîne B.3.1 ID article, faisant référence à un tableau se fait avec [crochets] (avec spécificateurs en option lowerbound:size) mais si vous voulez juste de se référer à un tableau d'un certain type (ou même un tableau d'objets), vous ne pouvez pas simplement écrire

<see cref="Object[]"/>

au lieu vous devez vous préciser faites une référence de type avec le préfixe T:, comme

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

Cela ne semble pas s'appliquer lors du référencement d'une surcharge spécifique d'une méthode, telle que

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

Answer 3

Vous venez de quitter le mot-clé et mettez dans param type comme ceci:

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