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

c#在dll上实现上下文帮助,以便在设计时使用,c#,C#,我用c#开发了一些dll库;现在,我需要知道是否有可能在我的项目中插入一个上下文帮助,当客户调用我的库的方法和事件时,该帮助将在designtime工作期间显示,如此链接上显示的屏幕截图 有可能这样做吗?有什么想法吗?谢谢大家 通过Jumpier将其称为XML文档。下面是基本语法 /// <summary> /// This class performs an important function. /// </summary> public class MyCla

我用c#开发了一些dll库;现在,我需要知道是否有可能在我的项目中插入一个上下文帮助,当客户调用我的库的方法和事件时,该帮助将在designtime工作期间显示,如此链接上显示的屏幕截图

有可能这样做吗?有什么想法吗?谢谢大家


通过Jumpier

将其称为
XML文档
。下面是基本语法

/// <summary>
///  This class performs an important function.
/// </summary>
public class MyClass{ }
//
///这个类执行一个重要的函数。
/// 
公共类MyClass{}

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


在Visual studio中,在将添加任何代码元素(类、属性、枚举、方法)和相应的注释存根之前的行中键入//。

文档是使用代码创建的

//
///此文本将显示在上下文帮助框中。
/// 
public void SomePublicMethod(){
...
}
要随此元数据一起发布dll

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

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