20_doxygen:win下vscode自动注释、生成doc

article/2025/9/27 20:51:32

文章目录

    • 1.结果如图
    • 2.win
      • 2.1设置目录
      • 2.2设置源码语言
      • 2.3设置输出doc
      • 2.4设置Graphviz路径
      • 2.5运行,生成doc
    • 3.VScode
      • 3.1注释自动补全
      • 3.2生成doc
    • 参考

如仅需要VScode注释自动补全,跳转至 3.1注释自动补全

1.结果如图

自动注释
请添加图片描述
生成doc

请添加图片描述

2.win

安装doxygen:下载链接

安装graphviz:下载链接

graphviz 用于绘制DOT语言脚本描述的图形。Doxygen 使用 graphviz 自动生成类之间和文件之间的调用关系图。参考自此

win下能够使用GUI界面,doxywizard

2.1设置目录

请添加图片描述

2.2设置源码语言

请添加图片描述

2.3设置输出doc

请添加图片描述

2.4设置Graphviz路径

请添加图片描述

2.5运行,生成doc

请添加图片描述

3.VScode

3.1注释自动补全


安装Doxygen Documentation Generator扩展

输入/**后按Enter自动生成格式化注释
请添加图片描述
在setting中配置注释的默认信息、格式,如Author作者信息配置
在这里插入图片描述

3.2生成doc

前置:win下已安装doxygen,已用doxywizard生成了Doxyfile(doxywizard生成doc成功以后,在设置的工作目录下就有Doxyfile)

安装Doxygen Runner扩展

在setting中配置Doxyfile路径、doxygen.exe路径

Ctrl + Alt + P执行Generate Doxygen documentation生成doc

或 View Doxygen documentation阅览doc

在这里插入图片描述

参考

  • Doxygen Documentation Generator
  • Doxygen Runner
  • windows下Doxygen的配置与使用

希望能帮助到朋友们,欢迎批评指正!


http://chatgpt.dhexx.cn/article/l1EItron.shtml

相关文章

在Win上学习使用Doxygen与GraphViz

安装 Doxygen官方下载 Graphviz Win上的最新版本 截止2018-04-06 Graphviz最新版本是2.38Doxygen最新新版是1.8.14 因为不想分心处理安装后的环境变量配置,所以都选择了可执行包。一路“确定”就安装好了。 使用 参考资料:【1】 使用Doxygen自带…

Doxygen、hhc生成chm格式文档

开源库中很多帮助文档是html格式,需要通过Doxgen生成 生成后有一系列文件,再通过hhc.exe打包成chm,就能方便拷贝到移动设备查看,比如IOS的chm sharp 下载Doxygen https://www.doxygen.nl/download.html 只需要下载其中的 binarie…

win10环境搭建

1、clion安装与配置 配置编译环境MinGW 解压MinGW.zip文件夹,配置环境变量:此电脑–>属性–>高级系统变量–>环境变量–>path D:\Program_Files\mingw64\bin安装clion 双击clion.exe文件安装,安装后将jetbrains-agent.jar文件复制到clio…

Win10+vs2017+OpenCV3.4.1+doxygen+cmake安装(DEBUG64位)

下载软件 软件:vs2017 网址:https://visualstudio.microsoft.com/zh-hans/vs/whatsnew/ 软件:opencv-3.4.1 网址:https://opencv.org/releases.html 软件:cmake-3.11(下载解压版本即可) …

Could NOT find Doxygen (missing: DOXYGEN_EXECUTABLE)

Could NOT find Doxygen (missing: DOXYGEN_EXECUTABLE) 使用cmake .. 有时候会遇到如下问题: $ cmake ..-- The CXX compiler identification is GNU 11.2.0 -- Detecting CXX compiler ABI info -- Detecting CXX compiler ABI info - done -- Check for worki…

win10系统msmq服务器,win10使用RabbitMQ实现消息队列

熟悉了 linux 下使用消息队列实现进程异步,转到 win10 下该怎么办? RabbitMQ 简介 可靠性(Reliability):RabbitMQ 使用一些机制来保证可靠性,如持久化、传输确认、发布确认。 灵活的路由(Flexible Routing):在消息进入队列之前,通过 Exchange 来路由消息的。对于典型的路由…

ThinkPHP框架漏洞总结

Thinkphp简介 ThinkPHP是为了简化企业级应用开发和敏捷WEB应用开发而诞生的,是一个快速、兼容而且简单的轻量级国产PHP开发框架,诞生于2006年初,原名FCS,2007年元旦正式更名为ThinkPHP,遵循Apache2开源协议发布&#…

Thinkphp5框架简单理解

说明 该文章来源于同事lu2ker转载至此处,更多文章可参考:https://github.com/lu2ker/ 目录 说明TP5框架简单理解1. 架构总览1.1 控制器/操作1.2 MVC模式流程1.3 类库自动加载1.4 URL访问检测1.5 路由模式1.5.1 普通模式1.5.2 混合模式1.5.4 强制路由 1.…

ThinkPHP框架-2

十、ThinkPHP框架中的模型 模型的作用、处理业务数据、与数据库进行交互。 1、导入数据表 新建tpshop数据库(create database tpshop character set utf8 collate utf8_general_ci) 导入数据表 说明:如果导入sql文件时,有报错,提示类似“…

ThinkPHP框架介绍及应用

一.ThinkPHP介绍 1.1.什么是框架 PHP框架是许多代码的集合,这些代码是程序结构的代码(并不是业务代码),代码中有许多函数、类、功能类包,框架的代码按照一定标准组成了一个有机的功能体,这个功能体中有许多设计模式如MVC、单例、…

thinkPHP框架学习(速成,一天)

一。TP框架介绍与配置 第一个是最开始沿用的一种结构,它有一个致命的缺点:比如说如果后端程序员在编写的过程中,前端程序就不能做修改,一旦修改了,那么肯定会有冲突。 后来大家进行了改进----把前端脱离出来。 再后来…

【代码审计-PHP】基于Thinkphp框架开发的

前言: 介绍: 博主:网络安全领域狂热爱好者(承诺在CSDN永久无偿分享文章)。 殊荣:CSDN网络安全领域优质创作者,2022年双十一业务安全保卫战-某厂第一名,某厂特邀数字业务安全研究员&…

thinkphp框架的使用

ThinkPhp知识大全(非常详细) 转载文章,感觉写的非常好 thinkphp.cn thinkphp 3.2版本 【框架项目部署】 部署一个Shop项目,使用tp框架 步骤: 创建入口文件: 1.在ThinkPHP目录下创建一个入口文件index.…

PHP之ThinkPHP框架

一、框架概述 1、什么是框架 框架就是一些代码类、方法(函数)、变量、常量的集合,这些代码是功能结构性的代码(并非业务代码)。业务代码其实就是具体的一些模块的增删改查逻辑代码。 使用框架开发项目,有…

ThinkPHP框架之快速入门

一.创建工程tp&#xff0c;目录结构如下: 在工程下导入thinkphp。 在tp中&#xff0c;可以在任何目录下创建入口文件&#xff0c;也可以把项目初始化到任何目录下. index.php: <?php //定义thindphp的路径 define(THINK_PATH, ./ThinkPHP/); //默认值当前目录下的./Thi…

PHP_thinkPHP框架(1)

能够理解并使用composer PHP一个包管工具 解决源码包 依赖问题 ​ 1.7.3 软件升级 composer self-update 能够安装Thinkphp5.1框架 composer create-project --prefer-dist topthink/think[版本号] 目录名称 ​ 安装之前一定要切换国内源&#xff0c;否则成功的概率很小。 …

使用ThinkPHP框架快速开发网站(多图)

使用ThinkPHP框架快速搭建网站 这一周一直忙于做实验室的网站&#xff0c;基本功能算是完成了。比较有收获的是大概了解了ThinkPHP框架。写一些东西留作纪念吧。如果对于同样是Web方面新手的你有一丝丝帮助&#xff0c;那就更好了挖。 以前用PHP做过一个很蹩脚的网站&#xff0…

ThinkPHP框架完全解析一

第一步&#xff1a;搭建应用和框架目录 文件系统结构如上图所示&#xff0c;新建一个名为tp_an的目录作为我们的应用目录。其中&#xff0c;ThinkPHP这个目录&#xff0c;就是thinkphp框架的目录。所有涉及到框架的开发&#xff0c;都会在ThinkPHP中进行。只是为了方便测试&…

Thinkphp框架初始及安装部署

一、框架概述 1、什么是框架 框架就是一些代码类、方法&#xff08;函数&#xff09;、变量、常量的集合&#xff0c;这些代码是功能结构性的代码&#xff08;并非业务代码&#xff09;。业务代码其实就是具体的一些模块的增删改查逻辑代码。 使用框架开发项目&#xff0c;有…

认识thinkphp框架

https://www.thinkphp.cn/down.html 版本5.0.24 ThinkPHP是一个免费开源的&#xff0c;快速、简单的面向对象的轻量级PHP开发框架 tp5 WEB部署目录&#xff08;或者子目录&#xff09; ├─application 应用目录 │ ├─common 公共模块目录&#xff08;可以更改&#xff09; …