Question

是否可以从与您编写摘要的方法不同的方法引用参数，如果是，那么语法是什么。

我知道<paramref name="..."/>，但我不知道如何引用其他方法。

简单幽默的例子，以防我不清楚：

/// <summary>
/// Does magical Foo things!
/// </summary>
/// <param name="magic">Magic Toggle!</param>
public void Foo(bool magic)
{
    //...
}

/// <summary>
/// Does Bar things. More down to earth, no <paramref name="Foo(bool).magic"/> involved!
/// </summary>
public void Bar()
{
    //...
}

（显然以上不是一个很好的用例，只是为了说明目的。）

Answer 1

此处没有recommended tag。

我怀疑没有推荐标签的原因是因为本文档的主要用例是以MSDN页面样式生成的文档，它没有使用指向其他方法的特定参数的链接。那说，它不是一个规范，只是一个建议。您编写的任何有效XML最终都会出现在输出XML文件中，因此如果您有一个自定义文档生成器可以使用它，那么就没有什么能阻止您添加“自定义”标记来执行您需要的任何操作。

就个人而言，我只是做这样的事情：

interface IFoo
{
    void Foo(object otherParam);

    /// <summary>Documentation for this method.</summary>
    /// <returns>The object passed as the otherParam argument of
    /// the <see cref="Foo" /> method.</returns>
    object Bar();
}

如何引用不同方法的参数？

1 个答案: