Question

我创建了一个.NET C＃组件，我将作为开发人员工具出售。我的问题是，如何将自己的自定义上下文帮助添加到方法和属性中。

所以，当我在方法上按F1时，我希望它转到特定的网页。这甚至可能吗？

Answer 1

使用Visual Studio SDK和帮助集成工具包 Visual Studio SDK的一部分是“帮助集成”项目类型。有关integrating with help here（MSDN）的信息。同样适用于VS 2005和2008。

对于早期版本的VS（在05年之前），这里是link to the download。

有关于Visual Studio SDK的entire development center。

这个工作比发送.Chm和/或IntelliSense文件要高很多，但我知道你想添加例子等。

考虑是否值得付出努力 您是否在IntelliSense文档文件（.xml）中为所有组件的程序集提供了足够的信息？

通常情况下，这足以提供大量信息，包括其他备注，备注等。

我可能会偏向于我的开发工作流程和我的同事的工作流程，但我不记得上次我看到有人在Visual Studio中按“F1”。

另外，如果您真的想要一个完整的.Chm帮助文件，那么您可以通过Sandcastle和以前的NDoc等工具轻松地将XML文档注释转化为该文档。

Answer 2

除了传统的F1帮助之外，我发现Sandcastle在部署任何可重用的库和框架时创建的CHM文件非常有用。事实证明，GhostDoc对于创建Sandcastle CHM文件所需的代码内XML非常有用。 Sandcastle还可以选择创建MSDN样式的HTML帮助文件以及经过验证的CHM。

Answer 3

通过代码中的XML文档生成上下文帮助。

如果您不熟悉它，在C＃.NET中，您可以通过在方法签名之前键入三个连续的正斜杠来记录函数：

/// <summary>
/// What Foo() does...
/// </summary>
/// <param name="bar">What bar is...</param>
/// <returns>What the return int is...</returns>
public int Foo(string bar)
{
    // Does something...
}

在VB.NET中，我相信它是三个撇号。

Answer 4

假设您熟悉使用xml注释创建xml intellisense文件，并且可以使用sandcastle分别生成.chm文件，那么缺少的部分就是F1集成。

这篇文章很古老，但表示how to do it with VS 6.0 era help

那里的评论会引导您the 2003 integration kit

除此之外，您似乎必须下载实际的VS SDK。

This page似乎很新（它有关于2010年更改的信息）

如何向程序集添加上下文帮助

4 个答案: