dotPeek 2025.2 Help

快速文档

使用 dotPeek,您可以直接在 代码查看器 中快速查看符号的文档。 如果符号以支持的格式(例如 C# 的 XML-docs)记录,您将看到所有格式化良好的文档。 否则,将显示基本的符号信息(例如完整的方法签名或类型可见性和命名空间)。

快速文档弹窗

查看符号的快速文档

  1. 将插入符号放置

    • 在 代码查看器 中的符号引用处,

    • 文件结构 窗口或任何其他 dotPeek 工具窗口中的符号处,

    • 在文档注释中的任意位置。

  2. Control+Q 或从主菜单中选择 查看| 显示快速文档…。 或者,您可以按 Control+Shift+A ,在弹出窗口中开始输入命令名称,然后在那里选择它。

  3. 在出现的 快速文档 弹窗中,您可以研究符号文档并通过超链接查看相关文档。

快速文档 弹窗的其他功能包括:

  • 固定窗口 按钮 ThemedIcon.Pin.Screen.(Gray).png ,在您需要在切换回 代码查看器 之前保留 快速文档 弹窗内容时非常有用。 点击此按钮后,弹窗会浮动,您可以与其他用户界面项交互。

  • 弹窗左上角的类似浏览器的后退/前进导航按钮。

  • 允许您导航到相关实体文档的超链接,包括:

    • 打开系统符号相关 Microsoft Docs 文章的 阅读更多内容 链接。

    • 将您带到符号声明的 转到 链接。

当 dotPeek 显示覆盖和实现成员的快速文档时,适用以下约定:

  • 如果覆盖/实现成员没有任何文档,但其基类成员有,则显示基类成员的文档。

  • 如果两者都有文档,则显示覆盖/实现成员的文档。

此功能的灵感来源并借鉴自 JetBrains ReSharper ,这是一款面向 Microsoft Visual Studio 的开发者生产力工具。

最后修改日期: 2025年 9月 28日