doxygen制作接口文档

系列文章目录

文章目录

  • 系列文章目录
  • 前言
  • 一、下载
  • 二、安装
    • 三、代码注释
    • 四、使用doxygen生成文档

前言

每次手动写接口文档太痛苦了,现在福利来了–doxygen
Doxygen是软件开发中广泛使用的文档生成器工具。它自动从源代码注释生成文档,解析有关类、函数和变量的信息,以生成HTML和PDF等格式的输出。通过简化和标准化文档过程,Doxygen增强了跨不同编程语言和项目规模的协作和维护。支持c++、Java、C#、PHP、Fortran
在这里插入图片描述

一、下载

Doxygen下载地址
在这里插入图片描述

二、安装

在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述

三、代码注释

在这里插入图片描述
接口代码头文件

#ifndef _CONGIG_DATA_H_
#define _CONGIG_DATA_H_#include "RegisterControl_Exports.h"
#include <iostream>
#include <fstream>
#include <sstream>
#include <map>
#include <vector>
#include "nlohmann/json.hpp"using namespace std;
using nlohmann::json;/// @brief: 这个类处理json格式数据
/// @author:xxxxxx
/// @version: v1.0
/// data:2024-8-8
namespace ConfigJsonData {class RegisterControl_API ConfigData{public:ConfigData();~ConfigData();	public:/// @brief 从文件中加载json数据/// @param fileName 文件名/// @return 无 注:内部输出加载json数据是否成功void loadJsonFile(const string& fileName);/// @brief 从字符串中加载json数据/// @param jsonString 输入json格式字符串/// @return 无 注:内部输出加载json数据是否成功void loadJsonString(const string& jsonString);/// @brief 内部构造json对象/// @param 无/// @return 返回json对象json toJson();/// @brief 序列化:把json数据转成ConfigData对象/// @param 无/// @return 无 注:如果转换失败,内部处理转换失败的异常void fromJson();/// @brief 把json数据保存到文件/// @param fileName 保存文件名/// @return 无 注:如果转换失败,函数内部处理转换失败的异常void saveToJsonFile(const string& fileName);/// @brief 把json数据保存到字符串/// @param 无/// @return 无 注:如果转换失败,函数内部处理转换失败的异常void saveToJsonString();public:// Getter 和 Setter 方法 /// @brief 获得json格式字符串/// @param 无/// @return 返回json格式字符串string getJsonString() { return _jsonString; }/// @brief 获得json对象/// @param 无/// @return 返回json格式字符串	const json& getJsonData() const { return _jsonData; }/// @brief 获得json对象/// @param jsonData json对象/// @return 无 设置json对象	void setJsonData(const json& jsonData) { _jsonData = jsonData; }/// @brief 获得json格式配置文件名/// @param 无/// @return string 返回文件名	const string& getFileName() const { return _fileName; }/// @brief 设置json格式配置文件名/// @param fileName 设置保存文件名/// @return 返回文件名void setFileName(const string& fileName) { _fileName = fileName; }/// @brief 获取ADC类型:ADC_82v48,ADC_ak8478,ADC_ak8446/// @param 无/// @return  返回ADC类型const string& getAdcType() const { return _adcType; }/// @brief 设置ADC类型:ADC_82v48,ADC_ak8478,ADC_ak8446/// @param adcType ADC类型/// @return string ADC类型void setAdcType(const string& adcType) { _adcType = adcType; }/// @brief 获取fpga信息/// @param 无/// @return 返回fpga信息map<string, int>& getFpgaMap()  { return _FpgaMap; }/// @brief 设置fpga信息/// @param fpgaMapfpga信息/// @return 无void setFpgaMap(const map<string, int>& fpgaMap) { _FpgaMap = fpgaMap; }/// @brief 获取相机信息/// @param 无/// @return 返回fpga信息const map<string, string>& getCameraInfoMap() const { return _cameraInfoMap; }/// @brief 设置相机信息/// @param cameraInfoMap信息/// @return 无void setCameraInfoMap(const map<string, string>& cameraInfoMap) { _cameraInfoMap = cameraInfoMap; }/// @brief 获取增益数据/// @param cameraInfoMap信息/// @return 增益数据const map<string, vector<int>>& getGainMap() const { return _gainMap; }/// @brief 设置增益数据/// @param gainMap 增益信息/// @return 无void setGainMap(const map<string, vector<int>>& gainMap) { _gainMap = gainMap; }/// @brief 获取偏移数据/// @param 无/// @return 返回增益信息const map<string, vector<int>>& getOffsetMap() const { return _offsetMap; }/// @brief 设置偏移数据/// @param offsetMap 偏移数据/// @return 返回增益信息void setOffsetMap(const map<string, vector<int>>& offsetMap) { _offsetMap = offsetMap; }/// @brief 获取索引、bank、寄存器数据/// @param 无/// @return 返回索引、bank、寄存器数据const map<string, map<string, map<string, int>>>& getIndexBankRegMap() const { return _indexBankRegMap; }/// @brief 设置索引、bank、寄存器数据/// @param 索引、bank、寄存器数据/// @return 无void setIndexBankRegMap(const map<string, map<string, map<string, int>>>& indexBankRegMap) { _indexBankRegMap = indexBankRegMap; }private:string _fileName;     ///json文件名string _adcType;      ///ADC类型:ADC_82v48,ADC_ak8478,ADC_ak8446string _jsonString;   ///json字符串map<string, int> _FpgaMap; /// fpga信息map<string, string> _cameraInfoMap; ///相机信息map<string, vector<int>> _gainMap;  ///增益数据map<string, vector<int>> _offsetMap;///偏移数据map<string, map<string, map<string, int>>> _indexBankRegMap;///索引、bank、寄存器数据json _jsonData;  ///json对象};
}#endif

这里只需要注释头文件即可,不需要在注释cpp文件中注释,当然您也可以连同cpp文件一起注释
格式如下:

/// @brief 功能说明
/// @param 参数1说明
/// @param 参数2说明
/// @param 参数3说明
/// @return 返回值说明

四、使用doxygen生成文档

1.配置文档项目路径、文档生成路径、文档项目名称
在这里插入图片描述
2.防止生成的文档包含中文乱码
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
3.生成chm
在这里插入图片描述
4.显示chm
在这里插入图片描述
5.展示效果,注意这里选择你的chm后缀名文件,就会生成目录,如果选择index.html,就不带目录
在这里插入图片描述
在这里插入图片描述

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.rhkb.cn/news/396691.html

如若内容造成侵权/违法违规/事实不符,请联系长河编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

LVS原理详解及部署

目录 一、LVS原理 1.LVS简介 2.LVS结构 3.IP负载均衡技术 4.LVS相关术语 二、LVS负载均衡四种工作模式 1.LVS-DR模式 2.LVS-NAT模式 3.LVS-TUN模式&#xff08;了解&#xff09; 4.FULL-NAT模式&#xff08;了解&#xff09; 三、LVS负载均衡十种调度算法 四、LVS部…

学习大数据DAY35 利用 echarts 的开源图表和 python 异常处理优化网站

目录 根据分数统计电影数量来生成图表 上机练习 14 添加异常 添加电影类型判断是整数及正整数异常 部署项目到 Nginx 上机练习 15 根据分数统计电影数量来生成图表 Echarts 官网&#xff1a; https://echarts.apache.org/examples/zh/index.html 下载柱状图和饼图 可以…

Java Enum类笔记

Java系列文章目录 文章目录 Java系列文章目录一、前言二、学习内容&#xff1a;三、问题描述四、解决方案&#xff1a;五、总结&#xff1a;5.1 学习总结&#xff1a; 一、前言 学习Enum类的笔记 二、学习内容&#xff1a; Eunm类的实操 三、问题描述 Eunm枚举的使用 四、解…

Datawhale X 魔搭 AI夏令营第四期-魔搭生图task1学习笔记

根据教程提供的链接&#xff0c;进入相应文章了解魔搭生图的主要工作是通过对大量图片的训练&#xff0c;生成自己的模型&#xff0c;然后使用不同的正向、反向提示词使模型输出对应的图片 1.官方跑baseline教程链接:Task 1 从零入门AI生图原理&实践 2.简单列举一下赛事的…

MongoDB教程

目录 介绍启动命令命令行操作常用命令总结MongoDB Compass 介绍 MongoDB是一个基于分布式文件存储的开源数据库系统&#xff0c;由C语言编写&#xff0c;旨在为WEB应用提供可扩展的高性能数据存储解决方案。MongoDB将数据存储为一个文档&#xff0c;数据结构由键值对组成&…

ibis:极具潜力的Python数据分析新框架

今天要给大家介绍的Python框架叫做ibis&#xff0c;没错&#xff0c;跟著名连锁酒店宜必思同名&#xff0c;其作者是创造了pandas、Arrow等著名框架的Wes McKinney。 ibis的核心理念是用同一套数据框操作API&#xff0c;统一操纵各种主流的数据运算框架&#xff0c;使得用户可以…

Ubuntu安装 IDEA

一、在官网下载 IDEA 下载IDEA For LinuxDownload the latest version of IntelliJ IDEA for Windows, macOS or Linux.https://www.jetbrains.com/idea/download/?sectionlinux下载好的安装包解压到/opt/中&#xff0c;目录名更改为 idea 二、对/opt/idea 目录下所有文件授予…

canal监听mysql增量数据发布到rabbitmq

canal工作原理 canal 依靠mysql主从备份的原理&#xff0c;模拟 MySQL slave 的交互协议&#xff0c;伪装自己为 MySQL slave &#xff0c;向 MySQL master 发送dump 协议MySQL master 收到 dump 请求&#xff0c;开始推送 binary log 给 slave (即 canal )canal 解析 binary …

C++11右值引用

什么是左值&#xff0c;什么是右值&#xff1f; 不可以单纯字面去理解&#xff0c;等号左边是左值&#xff0c;等号右边是右值。 左值&#xff1a;可以修改的可以认为是左值&#xff0c;左值通常是变量。 右值&#xff1a;通常是常量&#xff0c;表达式或函数返回值&#xff0…

浅谈C/C++指针和引用在Linux和Windows不同环境下的编码风格

目录 0. 前言 1. 代码块、函数体上的 { } 的规范 2. 指针和引用中的 * 和 & 符号的位置 1. Linux 环境下编码风格(gcc) 2. Windows 环境下编码风格(Visual Studio) 3. 简单总结 0. 前言 C/C因为高度的自由性&#xff0c;并没有对一些常见的编码风格进行限制&#…

Hive3:数据的加载与导出

一、加载数据 在创建表之后&#xff0c;表中没有数据&#xff0c;我们不可能insert存入数据。 而是&#xff0c;通过数据加载&#xff0c;将HDFS中的数据关联到Hive表中。 建表 CREATE TABLE myhive.test_load(dt string comment 时间&#xff08;时分秒&#xff09;, user_…

某客户ODS数据库undo段问题分析处理

概述 ODS数据库在7月22日4个时间点02:03,05:17,07:04,08:53分别报如下错误&#xff1a; 原因分析 Ora-1628&#xff1a;max # extents 32765 reached for rollback segment _SYSSMU19990_761259507$ Oracle 官方解释&#xff1a; Cause: An attempt was made to extend a roll…

VScode:前端项目中导出和导入插件

# 终端运行&#xff1a;导出扩展插件到指定路径&#xff08;txt&#xff09; code --list-extensions > C:\Users\UserName\Documents\extensions.txt # 终端运行&#xff1a;导入指定路径&#xff08;txt&#xff09;的扩展插件 Get-Content C:\Users\UserName\Documen…

渗透测试实战-菠菜站渗透测试(Nacos反序列化漏洞利用)

免责声明&#xff1a;文章来源于真实渗透测试&#xff0c;已获得授权&#xff0c;且关键信息已经打码处理&#xff0c;请勿利用文章内的相关技术从事非法测试&#xff0c;由于传播、利用此文所提供的信息或者工具而造成的任何直接或者间接的后果及损失&#xff0c;均由使用者本…

Python 设计模式之工厂函数模式

文章目录 案例基本案例逐渐复杂的案例 问题回顾什么是工厂模式&#xff1f;为什么会用到工厂函数模式&#xff1f;工厂函数模式和抽象工厂模式有什么关系&#xff1f; 工厂函数模式是一种创建型设计模式&#xff0c;抛出问题&#xff1a; 什么是工厂函数模式&#xff1f;为什么…

uniapp版本更新除了plus.runtime.getProperty的解决办法

以下是展示图 带尺寸的图片: 首先把以下代码放到想要更新弹出的页面 //template部分<uni-popup ref"popup" background-color"#fff"><versionUp handleCloseVersion"closeVersion"></versionUp></uni-popup>//script…

应急响应:Windows 入侵排查思路.

什么是应急响应. 一个组织为了 应对 各种网络安全意外事件的发生 所做的准备 以及在 事件发生后 所采取的措施 。说白了就是别人攻击你了&#xff0c;你怎么把这个攻击还原&#xff0c;看看别人是怎么攻击的&#xff0c;然后你如何去处理&#xff0c;这就是应急响应。 目录&am…

上海电信万兆宽带2026年将实现全城覆盖

为了响应号召&#xff0c;上海力争到2026年&#xff0c;初步建成以5G-A和万兆光网为标志的全球双万兆城市。上海电信正式对外宣布将于8月30日正式上线“美好家万兆融合套餐”&#xff0c;同时发布速率行业领先的“5G-A套餐”&#xff0c;上线“随翼选”云翼智选礼包&#xff0c…

【Go】手写简易go webserver

核心&#xff1a;实现net/http库中handler接口的ServeHTTP方法的实例&#xff0c;通过http.ListenAndServe注册后&#xff0c;所有的请求都会打到该实例的ServeHTTP方法里。Context是对请求对象和响应对象的封装&#xff0c;实现了获取请问请求参数、设置状态码、设置响应头、设…

WINDOWS核心编程-----3章,内核对象,是现在不同账号下测试

系列文章目录 终端服务命名空间中内核对象的测试程序 TerminalService程序需要用登录不同的windows账号同时运行。才能看出效果 建议测试流程 1&#xff0c;先登录windows账号A&#xff0c;运行两个本程序实例 2&#xff0c;保持上述两个实例人在运行中&#xff0c;在登陆wind…