讲师中心 微信公众号

工具推荐

视频效率加速
updream

一键生成高质量推广成片

剧云
剧云

中文短剧剧本制作平台

立刻MV
立刻MV

低成本歌曲 MV、视频生成

Laper
Laper

剧本策划到成片协作

VSCode类注释快捷键是什么?类结构说明添加方法

老萱吖_7909

老萱吖_7909

发布时间:2026-11-10 08:02:41

|

529人浏览过

|

来源于php中文网

原创

VSCode原生不支持在class行直接触发JSDoc模板,需将光标置于class正上方空行输入/**+回车;constructor需单独处理,且语言模式必须正确识别为javascript/typescript等。

vscode类注释快捷键是什么?类结构说明添加方法

VSCode 里 class 关键字本身不触发自动注释生成

直接在 class 前按 Ctrl+/ 或 Cmd+/,只会加一行 // 或 #,不会弹出 JSDoc 模板——这不是快捷键失效,而是 VSCode 原生不支持「光标停在 class 行就自动生成类文档」。真正能触发标准注释模板的,是语言扩展(如 TypeScript 官方、JSDoc 插件)配合特定输入模式。

用 /** + 回车触发类注释模板(JavaScript/TypeScript)

把光标放在 class 关键字**正上方空行**,输入 /** 然后回车,VSCode(配合 TypeScript 或 JSDoc 扩展)会自动补全为:

/**
 * 
 */
class MyClass {

这个行为依赖以下条件:

  • languageId 必须是 javascript、typescript 或 typescriptreact(不是 plain text 或 json)
  • 文件后缀需匹配,如 .ts、.tsx;.js 文件需开启 // @ts-check 或配置 "javascript.preferences.includePackageJsonAutoImports": "auto"
  • 未禁用 editor.suggest.snippetsPreventQuickSuggestions(否则代码片段不弹)

constructor 不会自动获得独立注释块

Document This、Auto Import 等主流插件对 class 生成注释后,constructor 方法仍需手动处理。常见错误是以为按一次 /** + 回车就能覆盖整个类结构——实际它只作用于当前光标位置,不会递归扫描成员函数。

VSCode
VSCode

避免常见的 VSCode 错误——设置冲突、调试器配置和扩展冲突。

下载

正确做法是:

  • 在 constructor() 上方空行单独输入 /** + 回车,生成独立构造函数注释
  • 或使用多光标:按 Ctrl+Shift+L(Win/Linux)选中所有方法名,再输入 /** + 回车(部分扩展支持批量触发)
  • 不要依赖「一键全类注释」——目前没有稳定跨语言、跨项目结构的通用方案

Python 类注释靠 """ + 回车,但非 JSDoc 风格

在 class 行上方输入 """ 并回车,VSCode 会生成三引号字符串模板,内容取决于是否安装了 Python Docstring Generator 等扩展:

"""
Summary of the class.
<p>Args:
...
"""

注意区别:

  • 这是字符串字面量,不是语法级注释(会被解释器读取,影响 help() 和 IDE 提示)
  • 不等价于 JavaScript 的 /** */,不能被 TSDoc 或 typedoc 解析
  • 若想统一风格,需在 settings.json 中配置:"python.editor.suggest.autoImports": true,并确保 Python 扩展已启用 docstring 支持

最常被忽略的一点:类注释是否生效,和文件是否被识别为对应语言强相关。右下角状态栏显示 Plain Text 时,/** 回车什么都不会发生——哪怕你写的是标准 TypeScript 代码。

热门AI工具

更多
UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

Flowith
Flowith Hot

Flowith是一款基于画布和智能体工作流的 AI 协作工作空间。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

相关专题

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

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

1595

2023.06.30

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

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

3432

2023.07.21

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

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

2129

2024.03.14

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

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

1767

2024.03.14

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

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

2627

2024.03.15

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

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

1858

2024.03.15

vscode用途介绍
vscode用途介绍

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

1302

2024.03.15

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

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

1156

2024.03.15

Postman身份认证怎么配置
Postman身份认证怎么配置

本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。

40

2026.11.06

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn