VSCode 本身不提供根据注释自动生成文档大纲的功能，需依赖插件（如 Document This）生成规范 JSDoc 注释，再配合 jsdoc CLI 生成 HTML 文档；Outline 视图仅显示代码符号结构，非真正文档大纲。
VSCode 本身不提供“根据注释自动生成文档大纲”的功能，它没有内置的文档生成器（如 JSDoc → HTML 工具），但可以通过插件 + 规范注释 + 配合命令实现类似效果。关键在于：你写的是什么注释、用什么插件解析、以及想在哪儿看到“大纲”。
用 Document This 插件快速生成 JSDoc 注释块
这是最直接解决“注释怎么写才有效”的一步。很多用户卡在手动敲 /** */ 和参数占位符上，导致后续工具无法识别。
- 安装插件
Document This（作者：joelday），重启 VSCode - 光标放在函数/类/方法名上，按
Ctrl+Shift+D（Windows/Linux）或Cmd+Shift+D（macOS） - 它会自动读取函数签名，生成带
@param、@returns占位符的 JSDoc 块，例如：
/**
* @param {string} name
* @param {number} age
* @returns {object}
*/注意：它只生成注释模板，不分析函数体逻辑；若参数名含下划线（如 _id）或用了解构（{ user }），可能漏掉，需手动补全。
用 vscode-docthis 配合 jsdoc CLI 生成 HTML 文档
真正“生成文档”的动作不在编辑器里，而在终端。VSCode 只负责写对注释，实际解析靠外部工具。
- 全局安装
jsdoc：npm install -g jsdoc - 确保项目根目录有
jsdoc.json配置（至少指定源码路径和输出目录） - 在终端运行：
jsdoc src/**/*.js -c jsdoc.json - 生成的 HTML 里，“Classes”“Modules”“Global”等就是你代码中带
@class、@module、@function注释的结构化大纲
常见坑：jsdoc 默认不处理 TypeScript，若用 TS，得加 @typedef 或配合 typedoc；另外，没加 @public 的成员默认被忽略，大纲里就看不到。
在侧边栏实时查看符号大纲，而非“文档大纲”
很多人误以为“文档大纲”是独立视图，其实 VSCode 的 Outline 视图（快捷键 Ctrl+Shift+O）显示的是语言服务提取的符号结构 —— 它能识别 JSDoc 中的 @class、@enum、@typedef，但不依赖注释内容，而是依赖语法定义。
- 打开一个 JS/TS 文件，按
Ctrl+Shift+O，就能看到函数、类、变量层级 - 如果注释里写了
@deprecated或@private，Outline 不会隐藏它们，但会加灰色/锁形图标提示 - 若 Outline 为空，大概率是没启用对应语言服务（比如纯
.js文件没开javascript.suggestionActions.enabled，或没装TypeScript and JavaScript Language Features插件）
这个视图不是“文档”，而是“代码结构快览”，但它响应快、无需构建，适合日常跳转。
别指望单靠注释生成完整 API 文档
真实项目里，靠注释生成的大纲往往只有骨架：函数名、参数名、返回值类型。缺少上下文说明、调用示例、错误场景、兼容性标记——这些必须人工补在 @description 或额外 Markdown 文件里。
更麻烦的是，JSDoc 解析器对嵌套泛型（如 Array<Record<string, number>>）、重载签名、装饰器（@Component）支持有限，容易漏节点。如果你需要带搜索、版本切换、交互示例的文档站，还是得切到 typedoc、storybook 或 docsify 这类专用工具。
