首页
学习
活动
专区
工具
TVP
发布
社区首页 >问答首页 >从C#中的接口继承XML注释

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

Stack Overflow用户
提问于 2010-09-23 03:46:30
回答 5查看 13K关注 0票数 80

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

代码语言:javascript
复制
interface myinterface {

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

}

然后实现是:

代码语言:javascript
复制
public class myclass : myinterface {


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

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

代码语言:javascript
复制
myclass foo = new myclass();
foo.method1("do something");

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

谢谢

EN

回答 5

Stack Overflow用户

发布于 2012-10-12 01:38:35

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

有关更多详细信息,请参阅the MSDN page

票数 9
EN

Stack Overflow用户

发布于 2010-09-23 03:50:22

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

票数 7
EN

Stack Overflow用户

发布于 2019-08-13 07:19:41

看起来<inheritdoc/>很快就会得到原生支持。

请参阅https://github.com/dotnet/csharplang/issues/313

票数 2
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/3773037

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档