VSCode 通过 /** 开头的注释块识别 JSDoc，支持 @param、@returns 等标签实现类型提示与参数补全，无需插件即可获得悬停提示和自动补全，配合 jsdoc 工具可生成 HTML 文档。
vscode本身不直接生成文档，但它对jsdoc 有强大支持，能帮你写得规范、看得清楚、还能补全和校验——真正让文档和代码一起成长。
JSDoc 怎么写才被 VSCode 识别
VSCode 靠注释块里的特定语法识别 JSDoc，不是所有注释都算数。开头必须是 /**（两个星号），结尾是*/，中间每行以* 开头（可选但推荐）。
- ✅ 正确：/** @param {string} name – 用户名 */
- ❌ 错误：/* @param {string} name */（少一个*）或// /** … */（普通单行注释包裹）
- 函数上方紧贴着写，不要空行，VSCode 才能准确关联到函数签名
常用 JSDoc 标签，写完立刻见效
写完标准 JSDoc，把光标停在函数名或变量上，按Ctrl+Space（Windows/Linux）或Cmd+Space（macOS），就能看到类型提示和描述；调用时也会自动显示参数说明。
- @param {Type} name – 描述：标注参数类型和含义，如@param {number} id – 用户唯一标识
- @returns {Type}：说明返回值，如@returns {Promise
} - @typedef：定义自定义类型，配合 @type 复用，适合复杂对象结构
- @deprecated：标记废弃，VSCode 会加删除线并警告
不用插件也能获得基础支持，但推荐加个轻量工具
VSCode 内置 JavaScript/TypeScript 语言服务已支持 JSDoc 解析、悬停提示、自动补全——开箱即用。如果想进一步生成 HTML 文档，可以搭配 jsdoc 命令行工具（全局安装npm install -g jsdoc），然后终端运行jsdoc src/**/*.js。
- 日常开发中，ES7 React/Redux/GraphQL Snippets这类扩展能快速插入 JSDoc 模板（输入 /** 回车自动展开）
- 不想装全局 jsdoc？试试 Document This（已归档但依然可用）或更现代的Auto Import 附带的 JSDoc 生成能力
- 注意：纯 JS 项目里，类型建议尽量用 JSDoc 原生语法（如{Array.
} ），避免 TS 专属写法（如string[]）以防兼容问题
基本上就这些。JSDoc 不是负担，是给未来自己留的便签——VSCode 让它写得顺、看得清、改得稳。
立即学习“Java 免费学习笔记（深入）”；
