代理方法应该使用什么文档标记

本文关键字：什么 文档 方法 代理 | 更新日期: 2023-09-27 18:01:12

假设我有一个这样的代码：

class A
{
    /// <summary>
    /// Some important text here
    /// </summary>
    /// <param name="a"></param>
    /// <param name="b"></param>
    /// <param name="c"></param>
    public void Method1(int a, int b, int c)
    {
    }
}
class B
{
    private A a = new A();
    // I'd like to show A.Method1 documentation here
    public void Method1(int a, int b, int c)
    {
        this.a.Method1(a, b, c);
    }
}

是否有任何标准的文档标记(例如，标准到足以在Visual Studio中显示正确的文档(可以实现这一点？

我想做这样的事情：

/// <SomeMagicTag ref="A.Method1" />
public void Method1(int a, int b, int c)

当我使用CCD_ 2时，让visual studio向我展示CCD_ 1的文档。

代理方法应该使用什么文档标记

您可以使用cref属性来引用A类的方法。

XML文档标记中的cref属性表示"代码引用"。它指定标记的内部文本是一个代码元素，例如类型、方法或属性

查看Microsoft文档：cRef属性

我已经想明白了。遗憾的是，这种方法不适用于visualstudiointellisense(至少在VS2013中不适用(，但它确实适用于sandcastle帮助文件生成器。

以下是我的问题中经过编辑的示例，以展示如何做到这一点：

/// <inheritdoc cref="A.Method1" />
public void Method1(int a, int b, int c)

它可以通过使用select属性进行进一步自定义，该属性可以包含用于仅继承引用注释中选定标记的xpath查询。

相关文章：