c# - c# 在 dll 上实现上下文帮助以在设计时使用

Question

我在 c# 中开发了一些 dll 库；现在我需要知道是否有可能在我的项目中插入上下文帮助，当客户调用我的库的方法和事件时，该帮助将在设计时显示，就像此链接上可见的屏幕截图一样

点击这里查看完整图片

有可能这样做吗？有什么想法？非常感谢大家

由跳跃者

Answer 1

它被称为XML Docs。这是基本语法。

/// <summary>
///  This class performs an important function.
/// </summary>
public class MyClass{ }

• XML 文档注释
• 推荐标签

Answer 2

您需要将 XML 代码注释添加到您的类、属性和方法中。构建应用程序时，检查 Xml 文档文件的构建选项。然后，您将 xml 文件与您的 DLL 一起分发。

在 Visual Studio 中，在任何代码元素（类、属性、枚举、方法）之前的行中键入 ///，并将添加适当的注释存根。

Answer 3

该文档是使用xml 注释在代码中创建的。

/// <summary>
/// This text will show up in the contextual help box.
/// </summary>
public void SomePublicMethod() {
    ...
}

要使用此元数据发布 dll，请生成 xml 文档。

为 Visual C# 项目生成 XML 文档文件 在解决方案资源管理器中选择项目后，在“项目”菜单上，单击“属性”。单击构建选项卡。在构建页面上，选择 XML 文档文件。默认情况下，文件创建在指定的输出路径下，例如“bin\Debug\Projectname.XML”。