从C#中的接口继承XML注释

Question

我想知道是否有人知道如何将接口xml注释链接到实现.问题是我希望基本注释首先来自我的界面.例:

interface myinterface {

       /// <summary>
       /// Does something.
       /// </summary>
       void method1(string foo);

}

然后实现是:

public class myclass : myinterface {


       public void method1(string foo) {
             //do something...
       }
}

所以现在如果我在实例化对象后用鼠标悬停在方法上:

myclass foo = new myclass();
foo.method1("do something");

如何使评论显示在悬停弹出窗口中？有没有什么方法可以将接口注释链接到实现？我知道Java中有一种方法,但找不到C#的解决方案.

谢谢

Answer 1

链接XML注释是不可能的恕我直言,但您可以使用像GhostDoc这样的工具将XML注释从您的Interface/Baseclass复制到实现/派生类.

Answer 2

XMLDoc定义了一个标记,<include />用于包含自Visual Studio 2003以来一直存在的另一个文件的注释.最大的警告是引用的文件应该是仅包含XMLDoc文档的文件,而不是另一个源文件.

有关更多详细信息,请参阅MSDN页面.

Answer 3

如果您使用GhostDoc,它可以帮助将文档从接口"传输"到实现代码.