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

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

.net c#

2

Andy · 技术社区 · 16 年前

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

所以,当我在一个方法上按F1时,我希望它转到一个特定的网页。这是可能的吗?

4 回复 | 直到 16 年前

1

3

Jeff Wilcox 16 年前

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

这里有一个 link to the download ,对于早期版本的vs(05年之前)。

有一个 entire development center 关于Visual Studio SDK。

这项工作感觉比传送.chm和/或intellisense文件要高得多,但我理解您希望添加示例等。

考虑一下是否值得付出努力 是否在IntelliSense文档文件(.xml)中为所有组件的程序集提供足够的信息?

通常情况下,这足以提供大量信息,包括附加备注、注释等。

我可能只是对我的开发工作流程和同事的开发工作流程有偏见,但我不记得上次在Visual Studio中看到任何人按“F1”时的情景。

另外,如果您真的想要一个完整的.chm帮助文件,那么您的XML文档注释可以通过类似这样的工具轻松地转换成它。 Sandcastle 以前的国家数据中心。

2

1

AJ. 16 年前

除了传统的F1帮助外,我发现sandcastle创建的chm文件在部署任何可重用库和框架时都非常有用。 GhostDoc 已经证明,对于创建sandcastle chm文件所需的代码内XML非常有用。sandcastle还可以选择创建msdn风格的html帮助文件以及尝试过的真正的chm。

3

0

Nick Gotch 16 年前

上下文帮助是通过代码中的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中,我相信它是三个撇号。

4

0

ShuggyCoUk 16 年前

假设您熟悉使用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年变化的信息)