5

代碼:XML註釋 - 您如何正確評論顯式實現的接口?

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指南無法區分,所以我想我正在尋找保證我的猜測是正確的。

回答

1

Sandcastle Help File Builder的快速測試顯示,在創建的文檔中,鏈接<seealso cref="IFoo.Bar()"/>指向接口中的方法,而<seealso cref="Bar()"/>指向該類中的方法。明確實現的方法的文檔是從接口繼承的,所以實際上應該指向接口方法。

編輯:ReSharper也抱怨<seealso cref="FooClass.IFoo.Bar()"/>並將其更正爲<seealso cref="IFoo.Bar()"/>然後指向接口方法,而不是明確實施的方法。

+0

這就是我的想法,但我不是100%確定。謝謝澄清。 – 2011-05-14 12:41:07

+0

不客氣。 – 2011-05-14 12:43:56

+1

那麼有沒有辦法通過xml註釋引用顯式定義的接口方法? – MDR 2013-11-16 23:28:10