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

如果您在使用 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。
三、使用快捷键生成 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 指向该文件路径。










