Better Comments 仅高亮注释而不生成标准文档,因其不解析函数签名、不支持块注释、无法自动推导参数;VS Code 内置 Insert JSDoc Comment 才能可靠生成含 @param/@returns 的标准 JSDoc 骨架。

Better Comments 是目前最实用、开箱即用的注释高亮插件,但它不生成标准文档;真正能一键生成函数/类级标准注释文档的,是 Document This(已停更)或更现代的替代方案 ESDoc 配合 vscode-esdoc,但实际落地最稳的是 Comment Anchors + 手动触发 Insert JSDoc Comment(VS Code 内置)。
为什么 Better Comments 不适合“生成标准文档”
Better Comments 的核心能力是视觉分类,比如把 // TODO: 渲染成橙色、// ! 渲染成红色。它不解析函数签名,也不插入参数说明、返回值、类型等结构化字段。
- 它只处理已有注释的样式,不主动插入新注释块
- 对
/** */块注释无感知,只作用于行注释(//)或单行/* */ - 无法根据 TypeScript 接口或 JS 函数参数自动推导
@param字段
VS Code 内置的 JSDoc 生成最可靠
VS Code 自带的 Insert JSDoc Comment(默认快捷键 Ctrl+Shift+P → 输入 “JSDoc” → 选中)能基于当前光标所在函数/方法,生成符合 JSDoc 规范的骨架注释。
- 支持 JavaScript 和 TypeScript,能识别参数名、返回类型(需有类型标注或 JSDoc 类型提示)
- 生成的模板含
@param、@returns、@example等标准标签,可直接编辑补全 - 不依赖外部模型或网络,无延迟、无隐私风险
- 在函数定义行按
/**+Enter也能自动触发(需启用javascript.suggest.autoImports和typescript.suggest.autoImports)
想全自动?注意两个现实约束
所谓“一键生成完整文档”,常被误解为“写完函数就自动生成带描述的注释”。但真实场景中,AI 插件(如 TabNine、CodeGeeX、通义灵码)生成的注释往往:
- 描述空泛(例如
@param id - the id),缺乏业务语义 - 对重载函数、泛型、回调参数识别不准,容易漏字段或错类型
- 无法区分
undefined/null/ 可选参数,导致@param标注失真 - 若项目未开启
checkJs: true或未配 TSDoc,TypeScript 插件可能完全不触发补全
推荐组合:轻量 + 可控 + 可维护
不要追求“全自动”,而是建立可持续的注释习惯:
- 用
Better Comments区分临时标记(// TODO)、风险提示(// !)、疑问(// ?)——这些本就不该进正式文档 - 函数/类定义完成后,立刻手动触发
Insert JSDoc Comment,填空式补全参数说明(20 秒内完成) - 配合
ESLint规则valid-jsdoc或jsdoc/require-jsdoc,在保存时提醒遗漏注释 - 如果团队用 ESDoc 或 TypeDoc 生成静态文档站,确保
@public、@private等可见性标签准确,否则生成器会跳过
真正难的不是生成那几行文字,而是让注释和代码逻辑始终同步——这没法靠插件解决,只能靠触发时机和检查机制卡住。


















