用VSCode快捷键一键生成函数和类的标准注释文档

P粉328763957

P粉328763957

2026-07-15

161人浏览

原创

vscode 默认不支持自动生成函数注释,需安装 document this 扩展并按 ctrl+alt+d(windows/linux)或 cmd+alt+d(macos)触发,光标须位于函数名前,支持 function、class、method 等语法定义结构,自动提取参数名与 ts 类型,但不推断语义描述,需手动补全。

用vscode快捷键一键生成函数和类的标准注释文档

VSCode 里按什么快捷键能自动生成函数注释?

默认没有。VSCode 自身不带函数注释生成功能,必须装扩展 + 配置触发方式。最常用的是 Document ThisES7+ React/Redux/React-Native snippets(对 JS/TS 有效),但后者只对函数声明/箭头函数等特定语法生效,且生成的是 JSDoc 框架,不是完整文档。

实操建议:

  • Document This 扩展(作者:joelday),它支持光标停在 functionconst 函数表达式、classmethod 上,按 Ctrl+Alt+D(Windows/Linux)或 Cmd+Alt+D(macOS)直接插入 JSDoc 块
  • 确保光标位于函数名正前方(比如 function<cursor> fetchData</cursor>),否则会失败或注释错位
  • 它会自动提取参数名、返回类型(TS 环境下更准),但不会推断参数含义或 @returns 描述,需手动补全
  • 不支持纯对象方法(如 obj.method = () => {}),只认语法层定义的函数

为什么按了 Ctrl+Alt+D 没反应?常见卡点

不是快捷键冲突就是上下文不匹配。Document This 只在光标处于“可识别声明节点”时激活。

常见错误现象和应对:

  • 光标在函数体内部(比如 function foo() { <cursor>console.log(1); }</cursor>)→ 移到 foo 左侧再试
  • 文件没保存,或语言模式不是 javascript / typescript / typescriptreact → 看右下角状态栏,点击切换语言模式
  • 用了 export default function 但没写函数名(匿名)→ Document This 不支持,必须写成 export default function getName
  • TS 项目中参数有重载签名(overload)→ 它只读第一个签名,可能漏参,建议关掉自动参数提取:"jsdoc.autoAddTags": false(在 settings.json 中)

类的注释怎么一键生成?class 和 constructor 要分开处理

Document Thisclass 关键字本身有效,但不会自动为 constructor 单独生成注释 —— 这是设计如此,不是 bug。

VSCode 1.118
VSCode 1.118

微软正式发布 Visual Studio Code 1.118 版本 。本次更新重点强化了 AI 开发体验与企业管理能力,其中最引人注目的是新增 Copilot CLI 远程控制功能,允许开发者通过手机或网页远程监控和接管 AI 会话 。同时,为了提高 AI 的运行性价比,新版本优化了令牌缓存策略以降低成本 。此外,1.118 版还引入了 Chronicle 本地历史追踪、TypeScript 7.0 支持以及更严格的企业级访问管控 。

下载

使用场景与操作差异:

  • 光标放在 class<cursor> User</cursor> 行,按 Ctrl+Alt+D → 生成类级 JSDoc,含 @class 和简要描述占位符
  • 光标放在 constructor<cursor>(props)</cursor> 行,再按一次 Ctrl+Alt+D → 单独生成构造函数注释,参数自动列出
  • 类中普通方法(如 getName())同样支持,但 getter/setter 需光标落在 get<cursor> name()</cursor>get 上才触发
  • 如果类继承了泛型(如 class Store<t></t>),它无法识别 T@template 需手写

想用内置 Snippets 替代扩展?可以,但限制多

VSCode 内置的 jsdoc snippet(输入 /** + 回车)只生成空 JSDoc 框,不自动填参。想让它智能一点,得改用户代码片段(code-snippets)。

实操建议(仅推荐给熟悉 JSON 的人):

  • 打开 Preferences: Configure User Snippets → 选 javascript.json
  • 加一条 snippet,前缀设为 docf,body 写:
    "/**\n * ${1:description}\n * @param {${2:type}} ${3:param} - ${4:desc}\n * @returns {${5:type}} ${6:returnDesc}\n */"
  • 这样输 docf + Tab 能快速展开模板,但依然不读函数签名,所有占位符都得手动填
  • 比起扩展,这种方式更适合固定模式的小项目,或者配合 Prettier + ESLint 自动补全 @returns 类型(需 TS + jsdoc/require-returns 规则)

真正省时间的,还是 Document This 配合 TypeScript 类型系统 —— 参数名和基础类型能猜八成,剩下两成描述语义,得人来定。别指望全自动,也别跳过校验步骤,尤其当函数有副作用或边界条件时,注释里漏写 @throws@deprecated 是高频翻车点。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
vscode是什么_vscode怎么安装配置
vscode是什么_vscode怎么安装配置

VS Code(Visual Studio Code)是一款免费、开源的跨平台代码编辑器,由微软开发和维护。它被广泛用于软件开发和编程,支持多种编程语言和框架。VS Code 同时提供了丰富的功能和扩展性,使开发者可以高效地编写、编辑和调试代码。

2023.06.30

765

18

vscode怎么运行代码
vscode怎么运行代码

vscode是一个运行于MacOS X、Windows和Linux之上的,针对于编写现代Web和云应用的跨平台源代码编辑器;vscode免费而且功能强大,对JavaScript和NodeJS的支持非常好,自带很多功能,例如代码格式化,代码智能提示补全、Emmet插件等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.21

1180

3

vscode使用的框架介绍
vscode使用的框架介绍

VSCode是一款跨平台代码编辑器,它基于Electron框架和Monaco Editor构建。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

982

12

vscode一般用来写什么语言
vscode一般用来写什么语言

VSCode是一款功能强大的代码编辑器,支持多种编程语言和文件格式。它内置对 JavaScript、Python、Java、C++、TypeScript、HTML/CSS、Go 等语言的支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

930

8

vscode可以写什么语言
vscode可以写什么语言

vscode是一款强大的代码编辑器,支持多种编程语言的开发。通过安装扩展,可以为 JavaScript/TypeScript、Python、Java、C#、PHP、Go、Ruby、Rust、HTML/CSS 等语言提供智能代码补全、调试和格式化等功能。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1436

12

vscode中文设置方法
vscode中文设置方法

方法一:在设置页面中,搜索“locale”,并选择“zh-cn”。方法二:按“Ctrl Shift P”快捷键,输入“Configure Display Language”,将语言修改为“zh-cn”。如果上述方法无效,可考虑安装中文插件。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1424

14

vscode用途介绍
vscode用途介绍

Visual Studio Code(VSCode)是一款由 Microsoft 开发的多功能文本编辑器,适用于各种编程语言。作为一款开源软件,VSCode 拥有代码高亮、自动补全、调试、Git 集成等强大功能,成为程序员不可或缺的工具。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

964

10

vscode和visualstudio的区别
vscode和visualstudio的区别

Visual Studio是一款功能强大的集成开发环境(IDE),适用于专业开发人员进行复杂项目的构建。而VSCode则是一款轻量级的代码编辑器,更适合各种规模的项目开发。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

839

8

vscode设置中文界面不生效解决方法
vscode设置中文界面不生效解决方法

vscode设置中文界面不生效解决方法:安装中文语言包、通过命令面板设置语言、检查 locale.json 设置、重新安装中文语言包、检查 VSCode 版本和更新、排除插件冲突、检查系统语言设置、查看 VSCode 日志和错误消息、重置 VSCode 设置、查看官方文档和社区支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

232

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程