VSCode通过JSDoc生成智能提示的方法及JS原生提示示例位置查询

一、VSCode 如何利用 JSDoc 生成智能提示 #

VSCode 的 JavaScript 语言服务会解析代码中的 JSDoc 注释，提取类型信息、描述文本和元数据，以此驱动各类智能提示功能：

• 函数调用时显示参数名称、类型和描述
• 变量、返回值的类型提示
• 对象属性的自动补全
• 悬停时展示详细文档

常用 JSDoc 示例 #

1. 函数参数与返回值说明

/**
 * 计算两个数的和
 * @param {number} a - 第一个加数
 * @param {number} b - 第二个加数
 * @returns {number} 两个数的总和
 */
function add(a, b) {
  return a + b;
}

调用 add() 时，VSCode 会弹出参数提示框，显示各参数的类型和描述。

2. 自定义对象类型

/**
 * @typedef {Object} 用户信息
 * @property {string} 姓名 - 用户的全名
 * @property {number} 年龄 - 用户的年龄（岁）
 * @property {boolean} 是否激活 - 账户是否处于激活状态
 */

/** @type {用户信息} */
const 用户 = {
  姓名: "张三",
  年龄: 25,
 是否激活: true
};

输入 用户. 时，会自动补全对象属性并显示对应的描述。

3. 可选参数与默认值

/**
 * 向用户发送问候语
 * @param {string} 用户名 - 目标用户的名字
 * @param {string} [问候语="你好"] - 可选的问候内容，默认值为"你好"
 */
function 问候(用户名, 问候语 = "你好") {
  console.log(`${问候语}，${用户名}!`);
}

VSCode 会标注 问候语 为可选参数，并显示默认值。

二、JavaScript 原生特性提示示例的获取（MacOS） #

VSCode 中 JavaScript 原生 API 的提示（如 fetch、Array.map 的参数说明、选项列表）基于内置的类型定义文件，这些文件已存储在你的本地设备中，无需额外下载。

查看示例的方法 #

• 打开任意 JavaScript 文件，悬停在某个原生 API 上（比如 Array.prototype.filter）
• 按下 Cmd + 点击（或右键选择「转到定义」），即可打开对应的类型定义文件
• 文件中包含大量 JSDoc 风格的注释，这些就是 VSCode 生成原生提示的依据，你可以直接参考这些注释的格式来实现自己的智能提示

本地文件路径参考 #

这些内置文件通常位于 VSCode 的应用目录下，你也可以通过以下路径找到（路径可能因版本略有差异）：
~/Library/Application Support/Code/extensions/ms-vscode.vscode-javascript-debug/out/debugAdapter/types

需要注意的是，虽然这些文件是 .d.ts 格式，但其中的注释完全遵循 JSDoc 语法，可直接用于纯 JavaScript 代码中，符合你不考虑 TypeScript 方案的需求。

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