使用C#的XML注释cref属性和params语法

Question

在C#中,我试图使用<see cref ="blah"/>来引用包含params关键字的方法签名.我知道这会将参数列表转换为数组,但我甚至无法弄清楚如何在CREF属性中引用数组.我在搜索中找不到任何内容,也不知道我知道的任何人.编译器在方括号上窒息.我已经尝试了各种不同的组合,使用花括号,使用Array类,但没有任何工作.有谁知道这个？

Answer 1

根据B.3.1 ID字符串格式文章,使用[方括号](带有可选lowerbound:size说明符)来引用数组,但如果您只想引用某个类型的数组(甚至是Object数组),则可以不要写

<see cref="Object[]"/>

相反,您需要指定您使用T:前缀进行类型引用,例如

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

当引用方法的特定重载时,这似乎不适用,例如

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

Answer 2

ECMA 334标准PDF,附件E包含对XML文档注释的不错概述.您可以在以下位置下载标准:

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

具体来说,您需要从第496页开始的E.3.1节.

类似的内容也在MSDN上(虽然MSDN似乎在这个主题上导航很糟糕,但很难找到其他部分):

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

相当于E.3.1:

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

您可能还会发现Mono的文档很有用:

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

具体而言,"CREF FORMAT"部分涵盖了ID字符串约定.

更新2018/05/23

上面的ECMA-334标准PDF的URL链接到最新版本的标准.2009年,这是该标准的第4版.但是,截至2017年12月,第5版是最新版,第4版的E.3.1部作为第5版的D.4.2部.

以下版本的ECMA-334标准可从以下页面下载:https://www.ecma-international.org/publications/standards/Ecma-334-arch.htm

Answer 3

你只需省略param关键字并输入如下类型:

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