企业官网建设流程全解析

1. 插件下载

Visual Studio Code 上快捷生成 doxygen 格式注释需要使用插件，推荐插件：cschlosser.doxdocgen，插件名全称 ：Doxygen Document Generator，如下图

插件下载地址：Doxygen Documentation Generator - Visual Studio Marketplace

2. 安装配置

下载完成后，打开 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>", "<tr><th>Date <th>Version <th>Author <th>Description", "<tr><td>{date} <td>1.0 <td>wangh <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": "wanghuan3037@fiberhome.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>", "<tr><th>Date <th>Version <th>Author <th>Description", "<tr><td>{date} <td>1.0 <td>wangh <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": "wanghuan3037@fiberhome.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 (xxxxxxx@fiberhome.com) * @version 1.0 * @date 2019-11-17 * * @copyright Copyright (c) 2019 XX通信公司 * * @par 修改日志: * <table> * <tr><th>Date <th>Version <th>Author <th>Description * <tr><td>2019-11-17 <td>1.0 <td>wangh <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博客