讲师中心 微信公众号
AI工具推荐 视频效率加速

VSCode的Doxygen Documentation Generator:自动生成代码文档

千萱同学_8318

千萱同学_8318

发布时间:2026-01-09 19:38:02

|

349人浏览过

|

来源于php中文网

原创

可通过安装并配置 Doxygen Documentation Generator 插件,在 VSCode 中快捷键(Option+Cmd+D)或命令面板触发,自动生成符合 Doxygen 规范的函数、类等注释模板,并支持自定义模板文件。

vscode的doxygen documentation generator:自动生成代码文档

如果您在使用 VSCode 开发 C/C++ 或 Python 项目时希望快速生成符合 Doxygen 规范的代码注释模板,则可能是由于缺乏对文档生成插件的配置或调用方式不明确。以下是实现自动生成 Doxygen 文档注释的具体操作路径:

本文运行环境:MacBook Pro,macOS Sequoia。

一、安装 Doxygen Documentation Generator 插件

该插件为 VSCode 提供了快捷键触发的 Doxygen 注释块生成功能,支持函数、类、结构体等常见代码元素的注释模板插入,无需手动编写标准格式。

1、打开 VSCode,点击左侧活动栏的扩展图标(或按 Cmd+Shift+X)。

2、在搜索框中输入 Doxygen Documentation Generator。

3、在搜索结果中找到作者为 ms-vscode 的官方插件(注意非第三方同名插件)。

4、点击“安装”按钮,等待安装完成并重启 VSCode。

二、配置 Doxygen 插件参数

插件默认行为可能不匹配当前项目语言或注释风格,需通过设置调整生成内容的语言标识、作者字段及换行策略,确保输出符合项目规范。

1、按下 Cmd+, 打开设置界面。

2、在右上角搜索框中输入 doxygen。

3、找到 Doxygen: Author 项,填入您的姓名或团队标识。

4、将 Doxygen: Language 设置为当前文件对应的语言,如 cpp 或 python。

windows-shell
windows-shell

Windows 命令行编码与兼容规范。涵盖 GBK/UTF-8 编码、PowerShell/pwsh 互操作、Python/Node.js、Git 配置及代码生成规则。适用于 Windows 10/11 + MSYS2/Git Bash 环境下的所有命令行操作。

下载

三、使用快捷键生成 Doxygen 注释块

插件支持在光标位于函数、类、变量定义行上方时,自动识别上下文并生成带参数、返回值、异常说明等字段的完整注释框架。

1、将光标置于函数声明行正上方空白处(例如 void calculate(); 的上一行)。

2、按下快捷键 Option+Cmd+D(macOS)或 Alt+Shift+D(Windows/Linux)。

3、插件将自动插入类似 /** @brief ... */ 格式的多行注释块,并高亮待填写字段。

四、通过命令面板调用生成功能

当快捷键冲突或需要更精确控制生成位置时,可借助命令面板手动触发,适用于嵌套函数、宏定义或特殊语法结构。

1、按下 Cmd+Shift+P 打开命令面板。

2、输入 Doxygen: Generate Comment 并回车。

3、若当前光标所在行存在可识别的符号定义,插件将立即在上方插入注释块;否则提示 No valid symbol found。

五、自定义注释模板文件

插件支持加载用户定义的 .dox 模板文件,允许替换默认注释结构,例如添加版本号字段、修改参数描述顺序或适配公司内部文档标准。

1、在项目根目录下新建文件 .vscode/doxygen-template.dox。

2、在该文件中按 Doxygen 语法编写模板,例如使用 @param[in] name 替代默认的 @param name。

3、在 VSCode 设置中将 Doxygen: Template Path 指向该文件路径。

热门AI工具

更多
WorkBuddy

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

DeepSeek

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

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

UpDream
UpDream Hot

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

二狗PPT
二狗PPT Hot

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

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

豆包大模型

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

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

相关专题

更多
golang结构体相关大全
golang结构体相关大全

本专题整合了golang结构体相关大全,想了解更多内容,请阅读专题下面的文章。

4994

2025.06.09

golang结构体方法
golang结构体方法

本专题整合了golang结构体相关内容,请阅读专题下面的文章了解更多。

5171

2025.07.04

javascriptvoid(o)怎么解决
javascriptvoid(o)怎么解决

javascriptvoid(o)的解决办法:1、检查语法错误;2、确保正确的执行环境;3、检查其他代码的冲突;4、使用事件委托;5、使用其他绑定方式;6、检查外部资源等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

636

2023.11.23

java中void的含义
java中void的含义

本专题整合了Java中void的相关内容,阅读专题下面的文章了解更多详细内容。

371

2025.11.27

windows查看端口占用情况
windows查看端口占用情况

Windows端口可以认为是计算机与外界通讯交流的出入口。逻辑意义上的端口一般是指TCP/IP协议中的端口,端口号的范围从0到65535,比如用于浏览网页服务的80端口,用于FTP服务的21端口等等。怎么查看windows端口占用情况呢?php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

3319

2023.07.26

查看端口占用情况windows
查看端口占用情况windows

端口占用是指与端口关联的软件占用端口而使得其他应用程序无法使用这些端口,端口占用问题是计算机系统编程领域的一个常见问题,端口占用的根本原因可能是操作系统的一些错误,服务器也可能会出现端口占用问题。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2898

2023.07.27

windows照片无法显示
windows照片无法显示

当我们尝试打开一张图片时,可能会出现一个错误提示,提示说"Windows照片查看器无法显示此图片,因为计算机上的可用内存不足",本专题为大家提供windows照片无法显示相关的文章,帮助大家解决该问题。

1508

2023.08.01

windows查看端口被占用的情况
windows查看端口被占用的情况

windows查看端口被占用的情况的方法:1、使用Windows自带的资源监视器;2、使用命令提示符查看端口信息;3、使用任务管理器查看占用端口的进程。本专题为大家提供windows查看端口被占用的情况的相关的文章、下载、课程内容,供大家免费下载体验。

2639

2023.08.02

Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

40

2026.10.28

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习

Buffalo框架快速入门指南
Buffalo框架快速入门指南

共0课时 | 0人学习

Valgrind支持平台说明
Valgrind支持平台说明

共0课时 | 0人学习

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

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