Doxygen Documentation Generator插件使用及配置

安装插件后，File–Preferences–Settings-- 中打开用户 setting.json文件

初步设置后如下所示：

{"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);

VSCode自动生成Doxygen格式注释相关推荐

Vs code自动生成Doxygen格式注释
前言程序中注释的规范和统一性的重要性不言而喻,本文就推荐一种在用vscode编写代码时自动化生成标准化注释格式的方法,关于Doxygen规范及其使用可查看博文代码注释规范之Doxygen. ...
用 Visual Studio 自动生成C/C++注释（Doxygen、XML）
文章目录引言方案一:用 Doxygen Comments 生成 Doxygen 风格注释 1. 在VS中安装 Doxygen Comments 扩展 2. 重启VS,启用扩展 3. 使用 Doxy ...
Eclipse用法和技巧十四：自动生成的TODO注释2
前面介绍了自动生成的TODO注释含义,配置以及如何去除的方法,这里介绍下TODO常见的用途.工作中经常会遇到写代码写到一半,被叫过去开会推动沟通.o(╯□╰)o 一般都有写代码停下来一段时间,再回来就 ...
Eclipse用法和技巧十三：自动生成的TODO注释1
使用eclipse的快捷键自动生成的代码,经常有这样的注释. 一眼看上去这个注释和一般的注释并无什么差别,不过TODO这个字符串的颜色不一样,应该有些内容.TODO是eclipse中提供的一种任务标签 ...
LaTex 自动生成IEEE格式的参考文献
因为IEEE要求的参考文献格式跟平时用到的有所不同,研究了一阵子才知道怎么弄,记录一下,怕忘了. 首先下一个IEEE的论文模板,进入官网后,点击下载ieeeconf.zip,解压后里面的就是latex ...
如何自动生成参考文献格式
参考文献是你完成一篇论文重要的过程,参考文献的格式也很重要.但是自己去手动写参考文献又有点麻烦,那么给定一篇论文,怎样自动生成参考文献的格式呢? 方法如下:(借助百度学术) (1)搜索百度学术进入百 ...
mybatis-generator自动生成数据库字段注释，类注释
重写CommentGenerator接口 package com.example.mybatisgenerator.generator;import org.mybatis.generator.api ...
使用eclipse生成html格式注释文档 [ javadoc ]
前言近期组织翻译Android一直在苦恼如何更加便利的进行翻译工作,当前形式为将页面上的API复制到WORD中再进行翻译,最麻烦的是格式问题,这里探索一下是不是我们可以直接在源码上进行翻译,然后利用 ...
自动生成VGG图像注释文件
在计算机视觉领域,实例分割是当今最热门的话题之一. 它包括图像中对象的检测/分割,即特定对象的定位及其所属像素的关联.像任何一种机器学习系统一样,训练主干结构需要大量图像.更具体地说,需要大量注释来训 ...

VSCode自动生成Doxygen格式注释

Doxygen Documentation Generator插件使用及配置

VSCode自动生成Doxygen格式注释相关推荐

最新文章

热门文章