c# - XML 注释——如何正确注释显式实现的接口(interface)？

Question

代码:

public interface IFoo
{
    void Bar();
}

public class FooClass : IFoo
{
    /// <summary> ... </summary>
    /// <seealso cref="?"/> //How do you reference the IFoo.Bar() method
    public void Bar() { }

    /// <summary> ... </summary>
    /// <seealso cref="?"/> //How do you reference the standard Bar() method
    void IFoo.Bar() { }
}

我的猜测是:

<seealso cref="IFoo.Bar()"/> //Explicitly implemented interface method
<seealso cref="Bar()"/>      //Standard method

但是，我不确定。 ECMA 指南没有帮助区分，所以我想我正在寻找保证我的猜测是正确的。

Answer 1

使用 SandcaSTLe Help File Builder 进行的快速测试表明，在创建的文档中，链接 <seealso cref="IFoo.Bar()"/>指向接口(interface)中的方法和<seealso cref="Bar()"/>指向类中的方法。显式实现方法的文档是从接口(interface)继承的，因此您实际上应该指向接口(interface)方法。

编辑:ReSharper 还提示 <seealso cref="FooClass.IFoo.Bar()"/>并将其更正为 <seealso cref="IFoo.Bar()"/>然后指向接口(interface)方法，而不是显式实现的方法。