.net - 将Visual Studio F1按键直接显示到我编写的组件的内部帮助服务器上

Question

我的代码带有XML注释，并且正在学习如何使用SandCaSTLe生成html API帮助文档。我将将该html文档发布到内部网站。

我如何在Visual Studio或我的程序集中注册该站点，以便当用户在我的程序集标识符之一的上下文中按F1键进入我发布的文档时，Visual Studio可以转到该站点？

Answer 1

您需要确保使用SandcaSTLe构建MS帮助查看器(mshc)格式。完成此操作后，将在输出目录中创建 list (.msha)。构建之后，它将启动向导以将内容添加到帮助查看器，但是要将文档添加到其他计算机上的Visual Studio，则必须手动添加内容。

使用Visual Studio热键和弦Ctrl+F1, M或仅使用F1打开“帮助”查看器，然后选择顶部的“管理内容”图标。然后，您只需要将其指向您的.msha文件即可。我已经可以通过网络共享来做到这一点，但是我想它可以在网站上正常工作，也许可以在URL的开头添加file://。

可以自动执行此部署，但是对于您的用例而言可能会显得过高。不过，可以在here上找到更多信息。