VSCode插件实现函数文档快速生成技巧

酷丽小哥_6930

酷丽小哥_6930

2026-09-23

513人浏览

原创

vs code中/** + enter未生成jsdoc,主因是文件后缀非.js/.ts、语言模式为plain text、或光标未紧贴函数声明行开头;document this插件已停更兼容性差,推荐改用vscode-jsdoc;doxygen插件失效多因系统未安装doxygen或未加入path。

vscode插件实现函数文档快速生成技巧

VSCode 里按快捷键没生成 JSDoc 或 Doxygen 注释,大概率不是操作错了,而是插件没装对、语言模式没切对、或光标位置不对——这些点卡住,再按一百次也没用。

为什么 /** + Enter 没反应?检查三件事

VSCode 自带的 JavaScript/TypeScript 支持只在满足条件时才触发 /** 补全:文件后缀必须是 .js.ts;右下角语言模式必须显示 JavaScriptTypeScript(不是 Plain Text);光标得紧贴函数声明行开头(不能缩进、不能空格、不能在函数体内)。

  • 如果右下角显示 Plain Text,点击它 → 选 JavaScriptTypeScript
  • 如果写的是 const fn = () => {}/** 默认不识别——改用 function fn() 再试
  • 装了插件但没重启 VSCode?执行 Developer: Reload Window(Ctrl+Shift+P 输入)

Document This 插件为啥 Ctrl+Alt+D 失效?

Document This 已停更,新版 VSCode 中兼容性变差,尤其在 TS 项目里常漏掉参数类型、返回值推导不准。它也不支持解构参数(如 ({ a, b }) => {}),生成的 @param 全是 {any}

VSCode
VSCode

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

下载
  • 替代方案:装 vscode-jsdoc(作者 spmeesseman),它专注 JSDoc,对 ES6+ 函数签名解析更稳
  • 快捷键冲突?打开 Preferences: Open Keyboard Shortcuts,搜 document this,删掉旧绑定,或直接用 /** + Enter
  • 想补作者/日期字段?Document This 的设置项叫 documentThis.authordocumentThis.dateFormat,别填错名字

Doxygen Documentation Generator 插件报 command not found?

这个插件本身不生成文档,只写注释模板;真正干活的是系统里的 doxygen 命令。插件静默失败,90% 是因为 doxygen 没装进 PATH

  • macOS:运行 brew install doxygen → 再跑 doxygen -v 看是否输出版本号
  • Windows:安装时务必勾选 Add doxygen to PATH,装完重启 VS Code 终端
  • Linux:用 sudo apt install doxygen(Ubuntu/Debian),然后验证 which doxygen
  • VS Code 内置终端里 doxygen -g Doxyfile 报错?说明上一步没走通,别往下配插件了

Python 函数 docstring 怎么一键生成?

Python 推荐用 Python Docstring Generator 插件,它能识别 Google/NumPy/Sphinx 多种格式,且支持类型猜测(比如从 def foo(x: str) -> int: 推出 @param x:@return:)。

  • 快捷键默认是 Ctrl+Alt+D(Win/Linux)或 Cmd+Alt+D(macOS),光标必须放在 def 行正上方
  • 想用 Google 风格?在 settings.json 里加:"autoDocstring.docstringFormat": "google"
  • 如果函数用了 *args**kwargs,插件通常不生成对应 @param —— 这是设计使然,得手动补

最易被忽略的其实是语言模式和光标位置:哪怕插件全装对、命令全可用,光标偏移一个字符,或者文件没认成对应语言,整个流程就断在第一步。别跳过验证环节,先确保 doxygen -vdoxygen --version 能跑通,再调插件。

相关文章

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

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

下载

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

相关专题

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

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

2023.06.30

1155

18

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

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

2023.07.21

2292

3

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

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

2024.03.14

1789

12

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

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

2024.03.14

1587

8

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

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

2024.03.15

2487

12

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

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

2024.03.15

1778

14

vscode用途介绍
vscode用途介绍

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

2024.03.15

1202

10

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

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

2024.03.15

1076

8

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

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

2024.03.15

414

5

热门下载

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

精品课程

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