VSCode没有一键生成完整开发文档的万能插件，所有“自动生成”本质是注释模板生成、文档提取、格式渲染三层协作；DocumentThis仅生成JSDoc框架，Doxygen插件专为C/C++/Python生成Doxygen风格注释，TypeDoc依赖TS项目中已写的JSDoc和正确配置的entryPoints。
VSCode 里没有“一键生成完整开发文档”的万能插件，所有所谓“自动生成”，本质都是分层协作：注释模板生成 + 文档提取 + 格式渲染。选错层级，就会卡在“生成了但没法用”上。
DocumentThis 只管函数/类的注释块，不碰项目级文档
它适合快速给单个 function 或 class 插入 JSDoc 框架，比如输入 /** + Tab 后自动补出 @param、@returns 占位符。但它不会读取 package.json、不扫描整个项目、也不生成 README.md 或 API 网站。
- 适用场景：写完一个新函数，立刻补结构化注释，避免漏掉参数说明
- 常见错误：期待它导出 HTML 文档——它根本没这个能力，连文件路径都不访问
- 参数差异：
documentthis.jsdocTemplate可改占位符文字，但不能加自定义字段如@since，除非改插件源码
Doxygen Documentation Generator 专攻 C/C++/Python 的 Doxygen 风格注释
它生成的是 /// 或 /** 开头、带 @brief @param 等标签的注释块，目标是喂给 doxygen 命令行工具后续处理。快捷键 Alt+Shift+D（Windows/Linux）或 Option+Cmd+D（macOS）触发，光标必须停在函数声明正上方空白行。
- 容易踩的坑：装了插件但
doxygen --version报错，说明本地没装 Doxygen 二进制，插件只负责写注释，不负责执行生成 - 语言支持靠配置：
Doxygen: Language设为cpp才能正确识别struct，设成python才能解析def函数签名 - 性能影响：无。它只是字符串拼接，不解析 AST，所以对大文件也秒出
TypeDoc 是 TypeScript 项目的文档出口，不是编辑器插件
typedoc 本身是命令行工具，VSCode 插件（如 vscode-typedoc）只是封装了运行入口。它真正依赖的是代码里的 JSDoc 注释 + typedoc.json 配置，比如 "entryPoints": ["src/index.ts"] 指定从哪开始扫描。
- 为什么生成的文档空空如也？大概率是
entryPoints路径写错，或代码里只有//行注释，没写/** */块注释 - 兼容性注意：TypeScript 5.0+ 默认开启
verbatimModuleSyntax，若typedoc版本太老（Cannot find module - 和 DocumentThis 关系：前者生成注释模板，后者消费这些模板——但两者不联动，你得手动跑
npx typedoc
readme-tree 只干一件事：把目录结构转成 Markdown 树
它不读代码、不解析注释、不抓 package.json 字段，就做一件事：在当前 README.md 光标处插入 ├── src/ 这类缩进文本。输出干净，天然支持折叠，但仅此而已。
- 必须手动补的三处：
## Installation、## Usage、## Contributing，否则别人点开 README 就走 - 别忽略
package.json的description字段：如果为空，生成的 README 顶部第一行就是空的，显得项目没人维护 - 和 markdownlint 组合用才完整：先用 readme-tree 插骨架，再用
markdownlint扫描标题层级、空行缺失等硬伤
真正难的不是生成，是让不同环节咬合：DocumentThis 写的注释要符合 TypeDoc 要求，Doxygen 的 @param 格式不能混进 TypeScript 项目，readme-tree 的目录树得和实际 src/ 结构一致——这些衔接点没人替你校验，全靠人工对齐。
