悬停查看函数文档最直接,鼠标停在函数名上几毫秒后弹出含签名、参数、返回值和注释的悬浮框;Ctrl+K Ctrl+I快速预览当前函数完整文档;命令面板搜Documentation: Show Documentation为兜底方案;插件如cppreference、rust-analyzer可补全标准库文档。

悬停查看函数文档最直接
把鼠标停在函数名上,几毫秒后就会弹出悬浮框,里面包含签名、参数说明、返回值和 JSDoc/Docstring 注释。这不需要任何快捷键,也不依赖文件是否保存——只要语言服务器已就位,光标一 hover 就生效。
常见问题:
- 悬停没反应 → 状态栏左下角检查语言模式(如显示
Plain Text就得手动点选成TypeScript或Python) - 注释不显示 → Python 项目确认
python.languageServer设为Pylance;TS/JS 项目确保有jsconfig.json或tsconfig.json(哪怕只写{"compilerOptions": {"allowJs": true}}) - 标准库函数只有签名没说明 → C/C++ 用户需装
cppreference插件;Rust 用户 rust-analyzer 默认带 std 文档,但需 Cargo.toml 存在且路径被rust-analyzer.linkedProjects正确引用
Ctrl+K Ctrl+I(Windows/Linux)快速预览当前函数
这个快捷键专为“看一眼当前函数的完整文档”设计:光标放在函数内部任意位置,按 Ctrl+K Ctrl+I,会在编辑器底部弹出带语法高亮的文档块,包含参数、类型、示例(如果写了)。它比悬停更稳——不会因鼠标抖动消失,也支持滚动查看长文档。
注意点:
- 仅对当前光标所在函数有效,不跨文件;若光标落在类方法里,它会显示该方法,不是整个类
- Python 中对
def函数和@property都生效,但对lambda或动态生成的函数无效 - 如果弹窗空白,大概率是函数没写 Docstring,或语言服务器没解析到(可先试
Ctrl+S保存再触发)
命令面板搜 Documentation: Show Documentation
当悬停和快捷键都不灵时,这是兜底方案:按 Ctrl+Shift+P(macOS 是 Cmd+Shift+P),输入 Documentation: Show Documentation 回车。它会强制调用语言服务器重新提取当前符号的文档,绕过缓存和自动触发逻辑。
适用场景:
- 刚改完 Docstring 但悬停还是旧内容 → 手动触发能刷新
- 函数定义在另一个 workspace 文件夹里,而当前窗口没激活该文件夹 → 命令面板能穿透路径限制
- VSCode 刚启动,语言服务器还在加载中 → 这个命令会等待 LSP 就绪后再执行,比盲按悬停更可靠
插件补位:cppreference / rust-analyzer 内置文档
标准库和第三方包的文档,内置悬停往往只给签名。这时候得靠插件补全:
- C/C++:装
cppreference插件后,选中printf按F1→ 输入cppreference: Search,结果直接在侧边栏渲染,支持离线 HTML 包 - Rust:
rust-analyzer默认集成 rustdoc,悬停时点击「Show docs」链接就能打开本地 rustdoc 页面;若链接失效,检查rust-analyzer.serverPath是否指向正确rustc安装目录 - Python:Pylance 对
requests.get这类常用包能显示摘要,但深度文档仍建议配合Python Docstring Generator插件补全自己写的函数
真正容易被忽略的是:所有这些功能都依赖「光标落在符号有效范围内」。比如 my_func() 调用末尾的 ) 上悬停,就不会触发文档——必须落在 my_func 字母上,哪怕只碰一个字符。


















