从C#中的接口inheritanceXML注释

我想知道是否有人知道如何将一个接口的XML注释链接到一个实现。 问题是我希望基本评论来自我的界面。 例:

interface myinterface { /// <summary> /// Does something. /// </summary> void method1(string foo); } 

然后执行是:

 public class myclass : myinterface { public void method1(string foo) { //do something... } } 

所以现在如果我在实例化对象后将鼠标hover在方法上:

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

我怎样才能使评论出现在hoverpopup? 有什么方法可以将接口注释链接到实现? 我知道在Java中有一种方法,但找不到C#的解决scheme。

谢谢

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

XMLDoc定义了一个标签<include />用于包含自从Visual Studio 2003以来一直存在的其他文件的注释。最大的缺陷是被引用的文件应该是只包含XMLDoc文档的文件,而不是另一个源文件。

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

如果您使用GhostDoc ,将文档从接口“传输”到实现代码中会有很大帮助。

http://blog.x-tensive.com/2008/02/fixml.html

这是一个后处理程序,在缺less原始文档系统的情况下有一些额外的选项。

从网站:

小结:

FiXml是由C#\ Visual Basic.Net生成的XML文档的后处理器。 它解决了一些与以这些语言编写XML文档相关的最恼人的情况: – 不支持从基类或接口inheritance文档。 即任何重写成员的文档都应该从头开始编写,尽pipe通常至less要inheritance其中的一部分。 – 不支持插入常用的文档模板,比如“这个types是单例 – 使用它的属性来获取它的唯一实例”,甚至“初始化类的新实例”。