VSCode 自动生成 Doxygen 格式注释

1. 插件下载Visual Studio Code 上快捷生成 doxygen 格式注释需要使用插件推荐插件cschlosser.doxdocgen插件名全称 Doxygen Document Generator如下图插件下载地址Doxygen Documentation Generator - Visual Studio Marketplace2. 安装配置下载完成后打开 Visual Studio Code点击界面左侧的扩展接着扩展栏右上角的 ... 按钮在下拉菜单中选择菜单底部的“从 VSIX 安装… (Install from VSIX…)”找到下载好的文件进行安装。安装完成后进入插件的扩展设置扩展页插件右下角的齿轮→扩展设置 (Extension Settings)。3. 使用及配置初步设置后如下所示{ window.zoomLevel: 0, editor.minimap.enabled: false, python.pythonPath: C:\\Users\\jordan\\AppData\\Local\\Programs\\Python\\Python37\\python.exe, workbench.iconTheme: vscode-icons, explorer.autoReveal: false, //取消左侧自动聚焦 terminal.integrated.shell.windows: D:\\Program Files\\Git\\bin\\bash.exe, terminal.external.windowsExec: D:\\Program Files\\Git\\bin\\bash.exe, todo-tree.highlights.enabled: true, // Doxygen documentation generator set doxdocgen.file.copyrightTag: [ copyright Copyright (c) {year} XX通信公司 ], doxdocgen.file.customTag: [ par 修改日志:, table, trthDate thVersion thAuthor thDescription, trtd{date} td1.0 tdwangh td内容, /table, ], doxdocgen.file.fileOrder: [ file, brief, author, version, date, empty, copyright, empty, custom ], doxdocgen.file.fileTemplate: file {name}, doxdocgen.file.versionTag: version 1.0, doxdocgen.generic.authorEmail: wanghuan3037fiberhome.com, doxdocgen.generic.authorName: wangh, doxdocgen.generic.authorTag: author {author} ({email}), doxdocgen.generic.order: [ brief, tparam, param, return ], doxdocgen.generic.paramTemplate: param{indent:8}{param}{indent:25}My Param doc, doxdocgen.generic.returnTemplate: return {type} , doxdocgen.generic.splitCasingSmartText: true, }解释如下{ // Doxygen documentation generator set // 文件注释版权信息模板 doxdocgen.file.copyrightTag: [ copyright Copyright (c) {year} XX通信公司 ], // 文件注释自定义模块这里我添加一个修改日志 doxdocgen.file.customTag: [ par 修改日志:, table, trthDate thVersion thAuthor thDescription, trtd{date} td1.0 tdwangh td内容, /table, ], // 文件注释的组成及其排序 doxdocgen.file.fileOrder: [ file, // file brief, // brief 简介 author, // 作者 version, // 版本 date, // 日期 empty, // 空行 copyright,// 版权 empty, custom // 自定义 ], // 下面时设置上面标签tag的具体信息 doxdocgen.file.fileTemplate: file {name}, doxdocgen.file.versionTag: version 1.0, doxdocgen.generic.authorEmail: wanghuan3037fiberhome.com, doxdocgen.generic.authorName: wangh, doxdocgen.generic.authorTag: author {author} ({email}), // 日期格式与模板 doxdocgen.generic.dateFormat: YYYY-MM-DD, doxdocgen.generic.dateTemplate: date {date}, // 根据自动生成的注释模板目前主要体现在函数注释上 doxdocgen.generic.order: [ brief, tparam, param, return ], doxdocgen.generic.paramTemplate: param{indent:8}{param}{indent:25}My Param doc, doxdocgen.generic.returnTemplate: return {type} , doxdocgen.generic.splitCasingSmartText: true, }效果如下当在文件头部输入 “/**” 后回车,效果如下/** * file main.c * brief * author wangh (xxxxxxxfiberhome.com) * version 1.0 * date 2019-11-17 * * copyright Copyright (c) 2019 XX通信公司 * * par 修改日志: * table * trthDate thVersion thAuthor thDescription * trtd2019-11-17 td1.0 tdwangh td内容 * /table */在函数上面 “/**” 后回车,效果如下/** * brief * param buffer My Param doc * param len My Param doc * return int */ int platform_oled_write(uint8_t *buffer, uint16_t len);参考文献Visual Studio Code 设置 doxygen 格式注释_vscode doxygen-CSDN博客vscode 自动生成Doxygen格式注释_vscode doxygen注释规范-CSDN博客