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

Question

在 C# 中，我尝试使用引用包含 params 关键字的方法签名。 我知道这会将参数列表转换为数组，但我什至不知道如何在 CREF 属性中引用数组。 我在搜索中什么也没找到，而且我认识的人也不知道。 编译器因方括号而窒息。 我尝试过各种不同的组合，使用花括号，使用 Array 类，但没有任何效果。 有人知道这个吗？

Answer 1

根据 B.3.1 ID string format 文章，引用数组是用[方括号]（带有可选的lowerbound:size说明符）完成的，但如果你只想引用某种类型的数组（甚至是对象数组），你可以不只是写

而是需要指定您正在使用 T: 前缀进行类型引用，例如

这似乎不适用于引用方法的特定重载，例如

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年，这是该标准的第四版。 然而，截至 2017 年 12 月，第 5 版已生效，第 4 版中的 E.3.1 节变成了第 5 版中的 D.4.2 节。

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

更新 2023/11/20

ECMA-334 标准链接现已https://ecma-international.org/publications-and-standards/standards/ecma- 334/

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