我如何上下文帮助添加到装配 [英] How do I add context help to an assembly

查看:127
本文介绍了我如何上下文帮助添加到装配的处理方法,对大家解决问题具有一定的参考价值,需要的朋友们下面随着小编来一起学习吧!

问题描述

我创建了一个.NET的C#组件,我会以销售为开发工具。我的问题是,我如何将自己的自定义上下文帮助添加到方法和属性。

I have created a .NET C# component that I am going to sell as a developers tool. My question is, how do I add my own custom context help to the methods and properties.

所以,当我preSS在F1的方法,我希望它去一个特定的网页。这甚至可能?

So, when I press F1 over a method I want it to go to a specific web page. Is this even possible?

推荐答案

使用Visual Studio的SDK和帮助集成套件 在Visual Studio SDK的一部分是帮助集成项目类型。有关信息与帮助这里(MSDN)的整合。同样适用于VS 2005和2008。

Use the Visual Studio SDK and the help integration kit Part of the Visual Studio SDK is the Help Integration project type. Information about integrating with help here (MSDN). Same applies for VS 2005 and 2008.

下面是一个<一href="http://www.microsoft.com/downloads/details.aspx?familyid=3eaeb657-98dd-4959-b946-9719fec3a3ce&displaylang=en"相对=nofollow>链接到下载,为早期版本的VS(05年之前)。

Here's a link to the download, for earlier versions of VS (before '05).

有href="http://msdn.microsoft.com/en-us/vsx/default.aspx" rel="nofollow">整个开发中心有关Visual Studio SDK的

There's an entire development center about the Visual Studio SDK.

在努力感觉比出货的.chm和/或智能感知文件高出不少,但我知道你想添加的例子,等等。

The effort feels a lot higher than shipping a .Chm and/or IntelliSense files, but I understand you'd like to add examples, etc.

考虑是否值得努力 您是否为您的所有组件的装配提供了智能感知文档文件(的.xml)足够的信息?

Consider if it's worth the effort Are you providing enough information in the IntelliSense documentation files (.xml) for all of your component's assemblies?

通常情况下,这是足以提供大量的信息,包括补充说明,注意事项等。

More often than not, that's sufficient to provide a lot of information, including additional remarks, notes, etc.

我可能只是偏向我的开发流程,而我的同事,但我不记得,我看到有人美元的Visual Studio中p $ PSSF1最后一次了。

I may just be biased to my development workflow and that of my co-workers, but I can't remember the last time that I saw anyone press "F1" in Visual Studio.

另外,如果你真的想知道确实需要一个成熟的.chm帮助文件,您的XML文档注释可以变成是不费吹灰之力的感谢状的沙堡和以前NDoc的。

Plus, if you really ever do want a full-blown .Chm help file, your XML documentation comments can be turned into that with little effort thanks to tools like Sandcastle and formerly NDoc.

这篇关于我如何上下文帮助添加到装配的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持IT屋!

查看全文
登录 关闭
扫码关注1秒登录
发送“验证码”获取 | 15天全站免登陆