VSCODE 使用插件 Doxygen Documentation Generator

2023-11-10

VSCODE 使用插件 Doxygen Documentation Generator

1.安装插件Doxygen Documentation Generator

在这里插入图片描述

2.修改相关代码(不改也可以,可跳过)

方法1,打开设置,从插件处更改

更改邮箱和姓名
在这里插入图片描述
在这一页我们还能看到许多可以自定义的地方,不过其它大多不痛不痒,我就偷懒不改了

方法2,修改setting.json

其实方法1最终自动修改的也是setting.json,只是可视化加上容易懂了。
组合键ctrl+shift+p打开命令,输入setting搜索,打开setting.json
添加以下内容

/*GXT-Doxygen Documentation Generator插件使用-Begin*/
"doxdocgen.generic.authorName": "gxt_kt",//更改作者名
"doxdocgen.generic.authorEmail": "gxt_kt@163.com",//更改邮箱
/*GXT-Doxygen Documentation Generator插件使用-End*/

在这里插入图片描述
如果出现红色报错,记得看下上面最后一行是不是漏了,
保存好就可以了

3.使用

在文件首行输入/**,然后按下回车,就可以看到自动补全的注释了
函数上方一行也是这么操作,显示效果示例
在这里插入图片描述

4.额外补充(可不看)

想要更加自定义可以修改相关代码,方法见2.2小节
这里给出一份demo,大部分不是我写的,也可以直接使用,不过效果实测一般般,细节还需要打磨,就放出来,有兴趣的可以试试

/*GXT-Doxygen Documentation Generator插件使用-Begin*/
// 作者名和邮箱
"doxdocgen.generic.authorName": "gxt_kt",
"doxdocgen.generic.authorEmail": "gxt_kt@163.com",
"doxdocgen.generic.authorTag": "@Author : {author} email:{email}",
// 日期格式
"doxdocgen.generic.dateFormat": "YYYY-MM-DD",
"doxdocgen.generic.dateTemplate": "@Creat Date : {date}",
// 简介格式
"doxdocgen.generic.briefTemplate": "@brief{indent:8}{text}",
// 文件注释的格式
"doxdocgen.file.fileTemplate": "@File Name: {name}",
"doxdocgen.file.versionTag": "@Version : 1.0",
"doxdocgen.file.copyrightTag": [
    "@copyright Copyright (c) {year} XXXX技术有限公司"
],
// 自定义文件注释格式
"doxdocgen.file.customTag": [
    "modification history :",
    "Date:       Version:      Author:     ",
    "Changes: ",
],
// 文件注释组成及顺序
"doxdocgen.file.fileOrder": [
    "file",		// @file
    "brief",	// @brief 简介
    "author",	// 作者
    "version",	// 版本
    "date",		// 日期
    "empty",	// 空行
    // "copyright",// 版权
    // "custom"	// 自定义
],
// 参数注释和返回注释的格式
"doxdocgen.generic.paramTemplate": "@param{indent:8}{param}: ",
"doxdocgen.generic.returnTemplate": "@return{indent:8}{type}: ",
// 函数注释组成及顺序
"doxdocgen.generic.order": [
    "brief",
    "tparam",
    "param",
    "return"
],
/*GXT-Doxygen Documentation Generator插件使用-End*/
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

VSCODE 使用插件 Doxygen Documentation Generator 的相关文章

  • 查看 Intellij 项目中的错误[重复]

    这个问题在这里已经有答案了 我使用的是 Intellij 版本 8 如何查看整个项目的警告或错误 UPDATE See 这个答案 https stackoverflow com a 19366569 104891这是最新的 这里最初的答案是
  • 有一个不错的 OpenCL 入门套件吗? [关闭]

    Closed 这个问题是无关 help closed questions 目前不接受答案 我有一些经验OpenGL它是可编程管道 我愿意给OpenCL不过 尝试一下 有人可以提出一个很好的集成套件来使用OpenCL 我只知道石英作曲家看起来
  • 嵌套 Linq Min() 使 Visual Studio 崩溃

    我有一段代码使 Visual Studio 2008 IDE 运行速度非常慢 消耗大量内存 最终导致其崩溃 我怀疑 VS 达到了操作系统内存限制 以下代码不是我的真实应用程序代码 但它模拟了问题 本质上 我试图使用 LINQ 找到树中的最小
  • Visual Studio:从撤消/重做堆栈中排除大纲

    Visual Studio 中有一些非常烦人的事情 当我展开或折叠方法或代码区域时 此操作会被推送到撤消堆栈上 因此 如果我在方法中编辑某些代码 然后折叠该方法 然后想要撤消我的更改 我必须撤消两次 一次用于折叠操作 一次用于代码更改 如果
  • 使用 PHPstorm 让 php 代码在浏览器中执行

    因此 当我单击 运行 时 PHPstorm 正在其控制台中正常运行 php 代码 这很好 但我想在浏览器中看到它 所以我在 PHPstorm 中创建了一个新的 PHP Web 应用程序 将服务器设置为 localhost 8000 现在 当
  • 用于 Java 项目的 NetBeans 远程编辑?

    我的项目使用了 Play 框架 所以我不需要可以编译的编辑器 我通常喜欢 NetBeans 但希望远程编辑服务器上的源文件以节省时间 我还经常在台式机 上网本之间切换进行开发 因此远程编辑可以使我免于同步开发环境 我对 Netbeans 远
  • 如何让 js2-mode 在 Emacs 中使用空格而不是制表符?

    我在用js2 mode http code google com p js2 mode 在 Emacs 中编辑 Javascript 但我似乎无法让它停止使用制表符而不是空格进行缩进 我的其他模式工作正常 只是遇到 js2 问题 你有 se
  • 更改 Eclipse 启动配置中的默认“要运行的程序”

    我时不时地使用以下命令从 Eclipse 中启动 JUnit 测试 运行方式 gt JUnit 插件测试 默认情况下 Eclipse 假设您正在运行需要工作台的东西 并在启动配置的 Main 部分中进行选择 LaunchConfig gt
  • 为家庭作业选择 Java IDE [关闭]

    Closed 这个问题正在寻求书籍 工具 软件库等的推荐 不满足堆栈溢出指南 help closed questions 目前不接受答案 谁能推荐一个轻量级的 Java IDE 不需要您每次编译和运行程序时都创建新项目 我只想能够打开jav
  • Visual Studio Professional 2013 Update 5 中的“在线服务不可用”问题

    我一直在 vscode 2013 工作直到今天 但是 当我今天早上尝试打开 IDE 时 它收到 您的许可证已过时 必须更新 错误消息 如下所示 在我尝试更新许可证和登录操作之后 当我尝试这两个时 它得到 在线服务不可用 请稍后重试 错误消息
  • “完美”的 Python 调试器具有哪些功能? [关闭]

    Closed 这个问题是基于意见的 help closed questions 目前不接受答案 请告诉我您希望当前的 Python 调试器具有哪些功能 我正在创建一个新的 Python IDE 调试器 并期待着具有挑战性的请求 请原谅我无耻
  • Netbeans 版本控制文件颜色代码?

    我试图找到一个图例来帮助解释 NetBeans 用于描述文件状态的不同颜色 我的一些文件颜色是 Grey Blue Green 还有其他我还没有发现的 如果有帮助 我将使用带有 CVS 的 Netbeans 6 7 这些颜色是什么 绿色意味
  • Kendo 有 GUI 设计师吗? [关闭]

    Closed 这个问题正在寻求书籍 工具 软件库等的推荐 不满足堆栈溢出指南 help closed questions 目前不接受答案 Kendo 有没有像 Sencha Architect for Ext JS 这样的控件布局设计工具
  • vs2008中的线程窗口在哪里

    我试图在 VS 2008 中找到描述的线程窗口here http www wintellect com cs blogs jrobbins archive 2007 08 01 neat new multithreaded debuggin
  • Visual Studio IDE 中功能后的空间

    如何设置 Visual Studio 中的设计以在我的 javascript 函数后面放置一个空格 目前 当我按下返回键时 我得到了这个 var myfunc function 当我想要这个的时候 var myfunc function 知
  • Eclipse 中选定单词的括号

    几天前 我觉得这个问题很愚蠢 所以不要将其发布在这里 但即使在搜索了很多之后 我也没有找到合适的解决方案 对于那些使用过的人TextEdit 在 Mac 上 他们会完全知道我在说什么 在编码时 我只想在单词或一行上加上引号或括号 为此 我必
  • 如何禁用 Qt Creator 中的“问题”窗格?

    我发现使用编译器输出更容易 但 Qt Creator 中的 问题 窗格会在每次编译后自动弹出 隐藏有用的信息 迫使我每次都隐藏它 有没有办法禁用这种行为 我不介意收集错误 我只是不希望每次我不要求时都显示这个特定的 UI 我使用的是 Qt
  • JavaScript IDE/编译器

    现在 我希望你们中的一些人能够理解我的要求 我是编程新手 我在 Codecademy com 上了解了 JavaScript 我使用 labs codecademy com 来编写 JavaScript 但它有限制 对于编程新手来说 我可以
  • 为 PlayStation 3 Linux 开发 [关闭]

    Closed 此问题正在寻求书籍 工具 软件库等的推荐 不满足堆栈溢出指南 help closed questions 目前不接受答案 我有兴趣开发软件索尼 PlayStation 3 http en wikipedia org wiki
  • Python 和 Django IDE 具有远程编辑功能吗?

    我正在寻找一个 IDE 它允许我编辑远程 Python 项目 并且还具有良好的 Django 支持 远程命令执行以及远程调试 我已经尝试使用 PyCharm 和 Aptana 与 PyDev 但我在配置它们进行远程编辑时运气不佳 感谢您的帮

随机推荐

  • 大数据问题汇总

    1最基本的 一个数据流 文件 求top k biggest solution 维护大小为K的最小堆 和堆顶比 大于堆顶的加入堆 堆顶相当于准入门槛 如果size 超过K 移除堆顶 vector
  • GPT-4最新使用体验:普通任务版

    当地时间 3 月 14 日 OpenAI 正式发布 GPT 4 据介绍 GPT 4是一个多模态大型语言模型 即支持图像和文本输入 以文本形式输出 扩写能力增强 能处理超过25000个单词的文本 在单词处理能力上是 ChatGPT 的八倍 并
  • 【Semantic Segmentation】语义分割综述

    Semantic Segmentation 语义分割综述 metric 为mIOU year method PASCAL VOC 2012 PASCAL Context Cityscapes ADE20K 2019 HRNet 54 0 8
  • 数据库模式 内模式 概念模式(模式)外模式

    外模式 视图 外模式又叫子模式或用户模式 对应用户级 用户能看到的数据库和视图 跟具体的程序或项目有关 可用DML来操作 概念模式 表 概念又叫模式 对应概念级 所有用户的公共视图 全局视图 可用数据定义语言DDL来定义 内模式 物理文件
  • 测试案例(五个案例)

    保温杯 功能测试 保温杯是否可以装热水 保温杯可以装多少水 500毫升 保温杯还可以装其他东西 比如可乐或者是其他人的液体 保温杯是否可以泡茶或者是咖啡 保温杯是否可以保冷 放入冰块 性能测试 保温杯是否可以装100摄氏度的水 是否可以用保
  • mysql给用户建表权限_MYSQL添加用户、建表、权限

    1 新建用户 登录MYSQL gt mysql u root p gt 密码 创建用户 mysql gt insert into mysql user Host User Password values localhost jeecn pa
  • mysql的sql语句日志记录

    sql日志开启 mysql的sql语句日志记录 SET GLOBAL log output TABLE SET GLOBAL general log ON SET GLOBAL log output TABLE SET GLOBAL gen
  • flutter过滤emoji正则表达式

    坑爹的flutter正则 emoji过滤正则表达式 u0020 u007E u00A0 u00BE u2E80 uA4CF uF900 uFAFF uFE30 uFE4F uFF00 uFFEF u0080 u009F u2000 u201
  • 使用Nodejs搭建HTTP服务,并实现公网远程访问「内网穿透」

    文章目录 前言 1 安装Node js环境 2 创建node js服务 3 访问node js 服务 4 内网穿透 4 1 安装配置cpolar内网穿透 4 2 创建隧道映射本地端口 5 固定公网地址 转载自内网穿透工具的文章 使用Node
  • bazel 学习笔记

    bazel 学习笔记 bazel重要概念 工作区 WORKSPACE 工作区包含目录和代码组织 管理了你所有的代码 包括依赖 代码库 repository 所有代码 包括主库和依赖的第三方库 常见的第三方库管理有 local reposit
  • NestedScrollView 嵌套Recyclerview 导致recyclerview无法滚动

    NestedScrollView 嵌套Recyclerview 导致recyclerview无法滚动 这边不是处理两者的滚动冲突
  • jeecg-boot在线开发从数据库导入表单(导入失败如何处理)

    当我们使用jeecg boot在线开发从数据库导入表单时发现 这里面始终找不到表单数据 但是我们数据库是有表的 1 操作 数据为空 2 继续发现请求的地址为 http localhost 3000 项目名 online cgform hea
  • 波形发生器 -- 输出正弦波,三角波,矩形波,锯齿波,梯形波 -- DAC0832

    波形发生器 输出正弦波 三角波 矩形波 锯齿波 梯形波 DAC0832 使用MSC 51单片机系统和相关电子器件 如 D A A D转换器 数码管或液晶显示器 运算放大器 示波器等 设计电路使其能产生正弦波 三角波 矩形波 锯齿波 梯形波
  • 如何让Windos系统定时休眠

    让Windows 10 计算机在1小时后只进行一次性的休眠 可以使用命令行或者批处理脚本来实现 以下是通过命令行来设置计算机在1小时后进行一次性的休眠的步骤 打开命令提示符 按下 Win R 键 输入 cmd 然后按下 Enter 键 这将
  • 利用多线程和 C++ 实现一个简单的 HTTP 服务器

    前言 服务器是现代软件不可或缺的一部分 而服务器的技术也是非常复杂和有趣的方向 随着操作系统不断地发展 服务器的底层架构也在不断变化 本文介绍一种使用 C 和 多线程实现的简单 HTTP 服务器 首先我们先来看一下如何创建一个服务器 int
  • IOCP机制与网络代理服务器实现方法

    请求问题 采用IOCP多线程控制模型建立高效网络代理服务器思想 能够较好地代理服务器中的多线程竞争问题 本文在比较基于该模型的两种编程方案的基础上 给出了基于Windows2000的网络代理服务器的设计与代理实现过程 关键词 完成端口重叠I
  • javadoc是什么

    Javadoc是什么 官方回答 Javadoc is a tool for generating API documentation in HTML format from doc comments in source code 译 Jav
  • 超简单! Flutter便捷添加资源图片,自动生成2x,x

    超简单 Flutter便捷添加资源图片 自动生成2x x https juejin im post 5e959da6e51d4546c349e52f 简书 https www jianshu com p 6df4663a7a14 注意 该插
  • C++11多线程:condition_variable头文件

  • VSCODE 使用插件 Doxygen Documentation Generator

    VSCODE 使用插件 Doxygen Documentation Generator 文章目录 VSCODE 使用插件 Doxygen Documentation Generator 1 安装插件 Doxygen Documentatio