ctrl+q 调出 quick documentation 前需满足三条件:光标停在已定义符号名上、项目已正确加载(ts 有 tsconfig.json,js 建议配 jsconfig.json)、jsdoc 注释紧贴声明且格式合规(/* / 内无空行,@param 等后跟空格与类型描述)。

WebStorm 的内置文档查看器(Quick Documentation)能直接解析 JSDoc、TypeScript 类型、OpenAPI 规范等,但不是所有注释都能显示——关键看符号是否被 IDE 正确索引且文档格式合规。
按 Ctrl+Q 调出文档前要确认三件事
很多用户按了 Ctrl+Q 没反应,其实是前置条件没满足:
- 光标必须停在已定义的函数名、类名、变量名或参数名上(比如
fetch、useState、getUser),停在字符串或空格里无效 - 项目需已正确加载:TS 项目要有
tsconfig.json;JS 项目建议配jsconfig.json或启用 “JavaScript Language Service” - JSDoc 注释必须紧贴声明上方,且格式合法——
/** */块内不能有空行,@param和@returns后要跟空格和类型描述
OpenAPI 规范文档怎么生效
如果你有 openapi.yaml 或 swagger.json,它不会自动挂载到代码补全里,得手动绑定:
- 路径必须在项目内:把规范文件放在
src/api/或根目录下,确保 WebStorm 已扫描到该文件(右键文件 → “Reload project from disk”) - 或添加远程 URL:进入
Settings/Preferences → Languages and Frameworks → OpenAPI Specification,点+粘贴 JSON/YAML 的直链(如https://petstore.swagger.io/v2/swagger.json) - 生效后,在
fetch('/users')或axios.get('/users')的 URL 字符串上按Ctrl+Q,就能看到对应 path 的请求参数、响应结构和示例
文档窗口里点链接打不开浏览器?检查这个设置
文档中渲染的 URL 或邮箱点击无响应,通常是因为:
-
Settings/Preferences → Editor → General → Other中,“Open links in browser” 复选框未勾选 - 当前文档来自本地 JS 文件(非 OpenAPI),则超链接仅限
@see或@link标签生成的,普通文字不会转为可点击链接 - macOS 上若用 Safari,默认可能拦截第三方弹窗,建议临时切到 Chrome 或 Firefox 测试
真正容易被忽略的是:JSDoc 注释里写 @example 时,如果代码块用了缩进而非 ```js 包裹,WebStorm 会跳过语法高亮和交互式执行按钮——哪怕文档弹出来了,也只当纯文本渲染。
大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!











