VSCode插件帮你自动生成符合标准的文档

夏萱小哥_5930

夏萱小哥_5930

2026-08-10

868人浏览

原创

doxygen documentation generator插件仅生成注释模板,依赖本地doxygen命令解析符号、填充@param等字段;若doxygen未加入path,插件将静默失败。

vscode插件帮你自动生成符合标准的文档

Doxygen Documentation Generator 插件必须搭配本地 doxygen 命令才能用

插件本身不生成文档,只负责写注释模板;真正解析符号、推断参数、填充 @param 和 @returns 的是系统里装的 doxygen 可执行文件。没它,插件连预览都出不来,所有“一键生成”都会静默失败。

常见错误现象:doxygen -v 在 VS Code 内置终端报 command not found;快捷键 Alt+Shift+D 按下后无反应;右下角语言模式明明是 C++,但光标停在函数上方仍不触发。

  • macOS:运行 brew install doxygen,再执行 doxygen -v 确认输出类似 1.9.8
  • Windows:下载官方安装包(如 doxygen-1.9.8-setup.exe),安装时务必勾选 Add doxygen to PATH,装完重启 VS Code 终端
  • Linux:运行 sudo apt install doxygen(Ubuntu/Debian),然后验证 which doxygen 是否返回路径

Document This 插件对 JS/TS 最友好,但不支持 C/C++ 函数签名解析

它能直接读取 function foo(a: string, b?: number): boolean 这类签名,自动填出 @param 类型和 @returns 类型,还能识别 JSDoc 已有字段避免重复。但遇到 C 函数如 int calc(int x, char *buf),它只会生成空占位符,@param 字段全为空——因为没做 C 语法解析器。

使用场景:适合前端、Node.js、TS 项目快速补注释;不适合嵌入式、驱动或纯 C/C++ 项目。

  • 触发方式优先用 /** + Tab,比快捷键 Ctrl+Alt+D 更稳定
  • 光标必须严格落在函数名正上方一行,不能在函数体内、注释行或空行中间
  • 若生成后 @param 缺失,检查当前文件右下角语言模式是否为 TypeScript 或 JavaScript,不是就点它手动切

Doxygen 插件的 @brief 和 @param 字段容易被忽略格式细节

Doxygen 默认生成的是 /// \brief 风格(Q#、C++ 常用),但很多 C 项目习惯用 /** ... */ + @brief。插件默认输出不带换行、不缩进,导致后续手写内容难对齐,也影响 Doxygen 解析。

VSCode
VSCode

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

下载

参数差异直接影响生成质量:

  • doxdocgen.c.triggerSequence 设为 /** 才能在 C 文件中触发块注释,设成 /// 就只响应行注释
  • doxdocgen.generic.dateFormat 建议设为 YYYY-MM-DD,避免 %Y-%m-%d 在某些 locale 下崩掉
  • 如果函数有指针参数如 char *path,插件默认生成 @param path,但 Doxygen 实际需要 @param[in] path 才标记输入方向——这个得手动补

Markdown All in One 的目录生成和 Document This 不冲突,但要分清职责

前者管项目级文档(README.md、设计文档),后者管代码内联注释。两者共存时容易误操作:比如在 .md 文件里按 /** + Tab,Document This 会试图解析 Markdown 标题当函数名,结果生成一堆无效 @param。

容易踩的坑:

  • 在 Markdown 文件里触发 Document This,会生成错乱注释;应关掉该语言模式下的插件,或用 "[markdown]": { "editor.quickSuggestions": false } 屏蔽
  • Create Table of Contents 命令默认插入到光标位置,不是文件开头;如果想固定放顶部,得先 Ctrl+Home 再执行
  • 中文标题生成的锚点是 URL 编码(如 #%E5%87%BD%E6%95%B0),点击跳转正常,但复制链接给别人看会显得不专业——建议配合 markdown.extension.toc.slugifyMode 设为 github

复杂点在于:注释生成不是“按个键就完事”,而是要先理清语言、工具链、输出目标三者匹配关系。比如 C 项目用 Document This 就是缘木求鱼,而 JS 项目硬套 Doxygen 插件又多一层配置负担。选哪个,得看代码写在哪、文档导出给谁看、要不要进 CI 流水线。

相关文章

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

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

下载

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

相关专题

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

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

2023.06.30

1255

18

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

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

2023.07.21

2632

3

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

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

2024.03.14

1889

12

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

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

2024.03.14

1707

8

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

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

2024.03.15

2587

12

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

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

2024.03.15

1798

14

vscode用途介绍
vscode用途介绍

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

2024.03.15

1242

10

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

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

2024.03.15

1116

8

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

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

2024.03.15

454

5

热门下载

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

精品课程

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