故障排除和反馈

本文提供了有关如何排查问题以及为适用于 Visual Studio Code 的触摸适配套件 (TAK) 编辑器扩展提供反馈的指导。

日志

日志是了解和排查 TAK 编辑器扩展问题的宝贵资源,该扩展在 Visual Studio Code 的“输出”面板(默认情况下,在 Windows 和 macOS 上的访问快捷键分别为 Ctrl+Shift+UCmd+Shift+U)中有 3 个输出通道:

  1. TAK 编辑器:该扩展的常规日志。 此通道可用于了解扩展的行为。 例如,在工作区中添加和删除捆绑包时,此通道中的日志将反映这些更改。 它还提供有关将发送到预览面板和从预览面板发送的消息的信息。
  2. TAK 编辑器语言服务器:此通道中的日志更详细,包含有关语言服务器(由 TAK CLI 托管)与扩展之间的通信的信息。 此处会记录由语言服务器发送或发送到语言服务器的每个通知和请求。
  3. TAK 编辑器语言服务器跟踪:这些日志更详细,包含扩展和语言服务器之间发送的原始 JSON-RPC 消息。 此通道通常用于调试,不需要进行更多故障排除。 但是,将其内容包含在发送给工程团队的 bug 报告中将会非常有用。

提供有关该扩展的反馈

如果在使用 TAK 编辑器扩展时遇到问题,或者有改进建议,可以通过以下两种方式之一提供反馈:

通过扩展提供反馈电子邮件

这在“预览”面板中显示为一个按钮,在命令面板中显示为一个命令。

  1. “预览”面板:“反馈”按钮

    “预览”面板中“反馈”按钮的屏幕截图

  2. 命令面板:搜索反馈并选择“触摸适配套件: 发送反馈电子邮件”

    选择其中任一选项将在默认电子邮件客户端中打开电子邮件草稿,其中预先填充了收件人、主题和正文模板。 你可以使用自己的反馈完善模板内容,并将电子邮件发送给工程团队。

    重要

    如果是 bug 报告,在反馈电子邮件中包含上述“输出”通道中的日志将有助于工程团队更好地了解问题。 但是,在发送之前,请务必确保日志中不包含任何敏感信息,因为它们可以包含有关工作区和运行扩展的计算机的信息,例如捆绑包存储位置的文件路径以及捆绑包的名称。

通过 VS Code 的“报告问题”报告 GitHub 问题

你还可以使用 Visual Studio Code 中的“报告问题”功能报告问题并提供反馈。 这将在 GitHub 存储库中打开一个新问题。

  1. 点按 Visual Studio Code 顶部栏中的“帮助”菜单。
  2. 选择“报告问题”。
  3. This is a:选择“Bug 报告”、“功能请求”或“性能问题”。
  4. File on:选择“扩展”。
  5. Extension:选择“触摸适配套件编辑器”
  6. 提供问题或反馈的标题和说明。 如果是 bug 报告,请提供重现问题的步骤。
  7. 对提供的信息感到满意后,点按“GitHub 上的预览”。 这会在 GitHub 存储库中打开问题,允许你查看信息并进行任何最终调整,然后提交问题。

警告

请注意,GitHub存储库是公开的,因此请勿在问题说明或注释中包含任何敏感信息。

VS Code 中“报告问题”窗口的屏幕截图