咨询为MS Project VSTO加载项添加帮助的推荐实现方式

我刚好做过类似的MS Project VSTO加载项帮助集成，分享几个能和开发流程同步推进的方案，亲测好用：

1. 嵌入式HTML帮助（轻量易维护） #

这是最灵活的方案，适合快速迭代的小项目，能和代码同步更新：

• 项目中新建HelpDocuments文件夹，用Markdown编写每个功能的帮助文档（比如TaskImport_Help.md），再用Pandoc或在线工具转成HTML，或者直接写HTML页面。
• 在加载项的UI上给每个功能添加「帮助」按钮，点击时调用C#代码打开对应帮助文件：

  private void btnHelp_TaskImport_Click(object sender, RibbonControlEventArgs e)
  {
      var helpPath = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "HelpDocuments/TaskImport_Help.html");
      Process.Start(new ProcessStartInfo(helpPath) { UseShellExecute = true });
  }
  

• 配置MSBuild自动复制帮助文件到输出目录：右键项目→属性→生成事件→后期生成事件命令行，添加：

  xcopy "$(ProjectDir)HelpDocuments\*" "$(TargetDir)HelpDocuments\" /E /Y /I
  

  这样每次编译代码，最新的帮助文件都会同步到输出文件夹。

2. Sandcastle + SHFB（结构化专业帮助） #

如果需要生成类似MSDN风格的API文档+操作指南，这个方案非常合适：

• 安装Sandcastle Help File Builder（SHFB），新建一个SHFB项目，关联你的VSTO项目的XML文档注释（记得在VSTO项目属性→生成里勾选「XML文档文件」）。
• 写代码时同步添加XML注释，比如：

  /// <summary>
  /// 导入外部任务到MS Project的核心方法
  /// </summary>
  /// <param name="filePath">外部任务文件路径（支持Excel/CSV）</param>
  /// <returns>导入成功的任务数量</returns>
  public int ImportTasks(string filePath)
  {
      // 方法逻辑
  }
  

  SHFB会自动把这些注释转换成API帮助页面，你还可以手动添加操作指南、截图等自定义内容。
• 把SHFB项目和VSTO项目的构建绑定：在SHFB项目属性里设置「在解决方案构建时自动构建」，或者在VSTO的后期生成事件里调用SHFB的命令行工具触发构建，实现代码编译和帮助生成同步完成。
• 加载项中添加入口打开生成的CHM或HTML帮助集即可。

3. Office自定义任务窗格帮助（沉浸式体验） #

想要完全贴合MS Project界面的帮助体验，可以用自定义任务窗格嵌入帮助内容：

• 在VSTO项目中添加「自定义任务窗格」，里面嵌入WebBrowser控件加载本地HTML帮助，或者用WPF控件展示富文本帮助。
• 给每个功能按钮添加事件，切换任务窗格的内容：

  private void btnTaskImport_Click(object sender, RibbonControlEventArgs e)
  {
      // 显示功能逻辑
      ShowHelpInTaskPane("TaskImport_Help.html");
  }
  
  private void ShowHelpInTaskPane(string helpFileName)
  {
      var helpPath = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, $"HelpDocuments/{helpFileName}");
      webBrowserHelp.Navigate(new Uri(helpPath));
      customTaskPane.Visible = true;
  }
  

• 优势是用户不用跳出MS Project就能查看帮助，帮助内容和加载项代码完全集成，版本控制更方便。

同步维护的实用技巧 #

• 把帮助文件和代码放在同一个Git/SVN仓库里，每次提交代码时同步提交帮助文档，避免版本不一致。
• 开发新功能时遵循「功能写完→补帮助→测试验证」的流程，不要攒到项目末期再补帮助，这样能保证帮助和功能完全同步。
• 部署时注意帮助文件的路径：如果是ClickOnce部署，要把帮助文件设置为「内容」并勾选「复制到输出目录」，确保部署后能正确访问。

内容的提问来源于stack exchange，提问作者Eric Christoph