代码之家 › 专栏 › 技术社区 › u84six

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

visual-studio-2010 .net c#

u84six · 技术社区 · 15 年前

我想知道是否有人知道如何将接口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语言的解决方案。

谢谢

5 回复 | 直到 7 年前

Noffls 15 年前

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

psaxton Spence 13 年前

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

见 the MSDN page 了解更多详细信息。

Fredrik Mörk 15 年前

如果你使用 GhostDoc 它有助于将文档从接口“传输”到实现代码。

Andreas Reiff 14 年前

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

它是一个后处理器,在缺少原始文档系统的情况下,它有一些额外的选项。

从网站:

小结:

Fixml是C \Visual Basic.NET生成的XML文档的后处理程序。它解决了一些与用这些语言编写XML文档相关的最麻烦的情况: -不支持从基类或接口继承文档。也就是说,任何被重写成员的文档都应该从头开始编写,尽管通常情况下,至少继承其中的一部分是非常可取的。 -不支持插入常用的文档模板,例如,此类型为singleton-使用其属性获取它的唯一实例,或者甚至初始化类的新实例。

K Johnson 7 年前

我构建了一个命令行工具来后期处理XML文档文件,添加了对<inheritDoc/>标记的支持。

虽然它对源代码中的intellisense没有帮助,但它允许修改后的XML文档文件包含在nuget包中,因此在引用的nuget包中使用intellisense。

见 www.inheritdoc.io 更多信息(免费提供)。

推荐文章

Robin Holenweger · 为什么有时需要使用模板类型作为指针时,使用模板类型会出现错误C2768?

7 年前

nnmmss · 从Datatable中选择,按多个带条件的列分组

7 年前

Nguyá»n Nam Khánh · 对richtextbox使用颜色,但当添加字符时,con trámouse会出错

8 年前

rodrigo.rodriguez · 如何注销或更改用户??在Visual Studio的Team Foundation Server中

8 年前

user8549227 · visual studio中的连接字符串出现奇怪问题

8 年前

Axel Podehl · 在Visual Studio 2010(及更高版本)中定义包含或链接路径变量的位置

8 年前

shilpa suresh · 在我的C#代码中显示错误“前一个catch子句已捕获此类型或超类型'System.Exception'的所有异常”

8 年前

Alan Gorsuch · mfc CEdit我应该什么时候进行验证?

8 年前

Christian · Visual Studio 2017未显示VS 2010项目的属性

8 年前

muaz · C++std::列出具有默认值的参数

8 年前