当前位置：首页 > news >正文

doxygen自动生成文档，注释容易错位的补充

news 来源：原创 2025/9/19 7:25:14

开发过程中，为了简化api开发文档的编写工作，我们可以使用doxygen的标注来进行文档注释，最后自动化的生成相关文档：
参考：https://developer.aliyun.com/article/935529
参考：https://blog.csdn.net/qq_34597963/article/details/144751954
按照相关说明，安装好doxygen，进行简单的配置后，就很可以立即使用了。

使用过程中有一个变量的注释容易被忽略：
单行注释：注释在一个新的行，前面标记“/**”后不需要符号"<“

 /**新的时间,注释放到单独行，不需要符号'<' */
int NewTime;

如果注释是放到和变量同一个行，则需要在标记“/**”后增加符号"<“。

int OldTime;/*!<旧的时间,注释放到后面，这里前面的符号'<'必不可少*/

如此一来，生成的文件描述才和变量一对一对应。
在这里插入图片描述

函数参数描述

dt后面要有一个空格，如果函数没有返回值，不要写@return，不然会有错误提示

/**
* @brief 获取实时日期和时间
* @param[in] dt 指向返回DATETIME类型的变量
*/  
extern void GetRtc(DATETIME *dt);

最后生成的效果就和预想的一致。
在这里插入图片描述

doxygen自动生成文档，注释容易错位的补充

开发过程中，为了简化api开发文档的编写工作，我们可以使用doxygen的标注来进行文档注释，最后自动化的生成相关文档： 参考：https://developer.aliyun.com/article/935529 参考：https://blog.csdn.net/qq_3459…...

编程日记 2025/9/19 7:25:14

git操作0409

git init git add. git commit -m "Initial commit" git checkout 7890abc # 切换到旧版本代码（只读） git checkout master # 切回最新版本 git checkout -b new_branch 789abcd # 或 git checkout -b new_branch HEAD~3 很重点 git reflog …...

编程日记 2025/9/19 7:23:03

电阻的额定功率与额定电压详解

一、基本定义额定功率（Rated Power） 定义：电阻在长期安全工作时允许消耗的最大功率，超过此值可能导致过热甚至烧毁。公式： P I R 或 P V / R （I：电流，V：电压&#…...

编程日记 2025/9/19 7:23:04

【后端开发】SpringBoot与Spring MVC

文章目录创建项目目录介绍Spring MVCservletMVCSpring MVCSpringboot与Spring MVC的区别Spring MVC交互创建项目新建一个Springboot项目对应描述目录介绍 src/main/java：Java 源代码 src/main/resources：为静态资源或配置⽂件： ----…...

编程日记 2025/9/19 7:20:36

如何禁用 PyCharm 的测试功能

如何禁用 PyCharm 的测试功能？ PyCharm 的测试功能默认会自动检测项目中符合命名规则的测试文件（如以 test_ 开头的文件）并关联测试框架。若需禁用该功能，可通过以下方法操作： 方法一：全局禁用默认测试框架…...

编程日记 2025/9/9 19:52:53

【Spiffo】光速项目：LVGL v9框架下的MIPI简易相机_Part2

简介本期接上回的工程部署讲一下整个工程的框架逻辑以及相关的模块作用机制，包括mipi抓图像以及后续传递到显示屏的链路逻辑等。一、核心逻辑 1、如何抓到图像数据并显示首先能够从摄像头捕获画面并显示是一个相机最起码要能实现的功能。所以先要搞清楚整个链…...

编程日记 2025/9/19 7:20:37

pycharm编译部署智能合约（solcx与web3搭配）

solcx 是一个 python 库，提供了 solidity 编译器的 python 绑定。它使开发者能够直接从 python 中编译 solidity 源代码，生成以太坊智能合约的字节码（Bytecode）和 ABI（Application Binary Interface）。这个库通常用于与 Web3 库配合使用，帮助开发者进行智能合约的部署、…...

编程日记 2025/9/15 3:12:29

微信小程序中的openid的作用

微信小程序中的openid的作用引言在当今数字化时代，用户体验成为了产品成功与否的关键因素之一。微信小程序作为连接用户与服务的重要桥梁，在提升用户体验方面发挥着重要作用。其中， openid（开放身份标识符）是微信小…...

编程日记 2025/9/19 7:23:02

AAAI 2025新研究！大语言模型+MARL=论文新思路？

最新研究显示，多智能体强化学习（MARL）正迎来一系列技术革新，让AI系统真正具备“群体智能”。同济大学团队提出的动态图通信网络（TGCNet），通过Transformer建模智能体间的动态协作关系&#xff0c…...

编程日记 2025/9/19 7:22:07

旅行世界宠物养殖合成游戏源码

旅行世界宠物养殖合成游戏源码，游戏养成类系统，用户能够通过养狗和参加其他活动获取算力，每日任务不断更新，完结即可收取算力，算力能够兑换现金红包。邀请好友得两级活跃收益提成，徒弟B100.%，徒…...

编程日记 2025/9/19 7:25:13

列表之链表_C

数据结构（邓俊辉）：列表及相关概念_listnodeposi-CSDN博客 #include <stdio.h> #include <stdlib.h>// 定义Rank类型为int typedef int Rank;// 定义ListNode结构体 typedef struct ListNode {int data;struct ListNode* pred;st…...

编程日记 2025/9/19 7:23:40

图解Java设计模式

1、设计模式面试题 2、设计模式的重要性 3、7大设计原则介绍...

编程日记 2025/9/19 7:23:04

CCF GESP Python编程四级认证真题 2025年3月

Python 四级 2025 年 03 月题号 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 答案 D C B C D C A A D B D A C B C 1 单选题（每题 2 分，共 30 分） 第 1 题 2025年春节有两件轰动全球的事件，一个是DeepSeek横空出世，另一个是…...

编程日记 2025/9/19 7:25:13

2025最新系统 Git 教程（四）

2.6 Git 基础 - 打标签打标签像其他版本控制系统（VCS）一样，Git 可以给仓库历史中的某一个提交打上标签，以示重要。比较有代表性的是人们会使用这个功能来标记发布结点（ v1.0 、 v2.0 等等）。在本节中…...

编程日记 2025/9/19 7:22:06

数学知识——欧拉函数

欧拉函数 1 ∼ N 1∼N 1∼N 中与 N N N互质的数的个数被称为欧拉函数，记为 ϕ ( N ) \phi(N) ϕ(N)。欧拉函数对于 N p 1 α 1 p 2 α 2 p 3 α 3 . . . p k α k Np_1^{\alpha_1}p_2^{\alpha_2}p_3^{\alpha_3}...p_k^{\alpha_k} Np1α1p2α2p3α3…...

编程日记 2025/9/18 21:16:24

Dify 识别 “subject“ and “intention“ 的提示词

Dify 识别 "subject" and "intention" 的提示词内容如下： You need to decompose the users input into "subject" and "intention" in order to accurately figure out what the users input language actually is. Not…...

编程日记 2025/9/19 7:20:06

Hi168云平台部署Ansible学习环境

前言之前发布的文章已经介绍过了在Hi168云平台部署openEuler学习环境，那么既然能部署openEuler了，其他的各类学习环境自然也就可以部署了。 Ansible简介 Ansible 是一个运维自动化工具，可以通过 SSH 协议对远程主机进行管理，对…...

编程日记 2025/9/18 12:27:30

Anacond虚拟环境里安装GPU版本Pytorch

CUDA/cudnn/CUDAToolkit简单区分 pytorch与cuda关系简单介绍 pytorch是一个深度学习的框架，能够调用cuda进行gpu加速。一般来说你的电脑里是有相关cuda的驱动的（可用nvidia-smi命令验证，能运行就说明有，不能运行去搜索安装&#…...

编程日记 2025/9/19 2:16:33

FRP的proxies只是建立通道，相当于建立与服务器沟通的不同通道而不是直接将路由器与服务器云端沟通

没有更好的办法了吗，我看frpc.toml的里面可以设置两个proxies那我esp32的监听端口设置在frpc.toml里面它不也能跟云服务器建立联系吗，比如远程与本地端口都配置为5112那云服务器接收到的5112访问会以frp配置的本地端口5112转发到frp客户端的路由器&#…...

编程日记 2025/9/19 7:20:38

Android开发鸿蒙环境问题记录

Android开发鸿蒙环境问题记录 （用于记录开发中鸿蒙环境差异及问题，持续更新） 2025.4.9 问题使用android.intent.action.TIME_TICK广播时，动态注册在鸿蒙4.0系统正常，但在鸿蒙3.0系统无法接收广播。解决方案在An…...

编程日记 2025/9/12 21:00:37

在 WSL2的 Ubuntu 20.04 中安装 Docker

WSL1升级到WSL2参考：WSL1升级到WSL2注意事项-CSDN博客 1. 更新系统包首先，确保系统包是最新的： sudo apt update sudo apt upgrade -y sudo apt upgrade -y 是 Ubuntu/Debian Linux 系统中的一条命令，用于升级所有已安装的软…...

编程日记 2025/9/15 22:01:04

LeetCode 252 会议室题全解析：Swift 实现 + 场景还原

文章目录摘要描述题解答案题解代码分析示例测试及结果时间复杂度空间复杂度总结摘要在这篇文章中，我们将深入探讨LeetCode第252题“会议室”的问题，提供一个用Swift编写的解决方案，并结合实际场景进行分析。通过这篇文章，你将…...

编程日记 2025/9/19 7:23:41

Postman的内网使用教程

在软件开发和测试过程中，接口测试是确保系统间通信正常的重要环节。当处于内网环境，无法直接访问外网资源时，如何高效地使用Postman进行接口测试也逐渐成为许多开发者关心的问题。前期准备安装Postman 从官方网站下载并安装最新版本的Pos…...

编程日记 2025/9/19 7:23:38

【软件测试】Postman中如何搭建Mock服务

在 Postman 中，Mock 服务是一项非常有用的功能，允许你在没有实际后端服务器的情况下模拟 API 响应。通过创建 Mock 服务，你可以在开发阶段或测试中模拟 API 的行为，帮助团队成员进行前端开发、API 测试和集成测试等工作。 Mock 服…...

编程日记 2025/9/19 7:22:06

【NLP 57、LLM通用能力评价方式】

人生如题，放下，是最优雅的解法 —— 25.4.9 目前，我们通过一些特殊的“集合”来评价大语言模型效果一、MMLU 集合测量大规模多任务语言理解评估模型在57个学科领域的综合知识理解能力，覆盖人文、社科、STEM&…...

编程日记 2025/9/14 11:47:07

centos7.9升级OpenSSL 1.1.1

centos7.9升级openssl 人工智能已经很准了： 问题： [rootcentos01 ~]# openssl version OpenSSL 1.0.2k-fips 26 Jan 2017 [rootcentos01 ~]# cat /etc/redhat-release CentOS Linux release 7.9.2009 (Core) 需要升级OpenSSL，请给出具体…...

编程日记 2025/9/19 7:20:37

10A 大电流 DCDC 降流芯片 WD5030

10A 大电流 DCDC 降压芯片 WD5030 在电子设备的电源管理领域，高效稳定的 DCDC 芯片至关重要。今天我们来深入探讨一款性能卓越的 10A 大电流 DCDC 降流芯片 ——WD5030。它在众多电子应用场景中展现出了强大的优势，为各类设备的稳定供电提供了可靠保障。…...

编程日记 2025/9/19 7:20:08

# 基于BERT的文本分类

基于BERT的文本分类项目的实现一、项目背景该文本分类项目主要是情感分析，二分类问题，以下是大致流程及部分代码示例： 二、数据集介绍 2.1 数据集基本信息数据集自定义类型二分类（正面/负面）样本量训练集验证…...

编程日记 2025/9/10 13:19:05

Verilog学习-1.模块的结构

module aoi(a,b,c,d,f);/*模块名为aoi，端口列表a、b、c、d、f*/ input a,b,c,d;/*模块的输入端口为a,b,c,d*/ output f;;/*模块的输出端口为f*/ wire a,b,c,d,f;/*定义信号的数据类型*/ assign f~((a&b)|(~(c&d)));/*逻辑功能描述*/ endmoduleveirlog hdl 程…...

编程日记 2025/9/19 7:20:36

界面控件DevExpress WPF v25.1新功能预览 - 数据网格、报表性能增强

DevExpress WPF拥有120个控件和库，将帮助您交付满足甚至超出企业需求的高性能业务应用程序。通过DevExpress WPF能创建有着强大互动功能的XAML基础应用程序，这些应用程序专注于当代客户的需求和构建未来新一代支持触摸的解决方案。无论是Office办公软件…...

编程日记 2025/9/11 9:02:33

【创新实训个人博客】prompt嵌入

通过对camel技术的理解，修改了项目内容能够初步实现广告内容相关的文本修改了typing.py中的定义 class RoleType(Enum): ASSISTANT "assistant" USER "user" CRITIC "critic" EMBODIMENT "embodiment" DEFAULT &q…...

编程日记 2025/9/13 21:41:07

Linux 进程的替换

进程程序替换要讲好这个我为大家准备了五个步骤 1. 先用代码给大家展示一下现象 2.解释原理 3.将代码改成多进程版 4.使用所有的方法，并认识函数参数的含义。 5.其他我们现在开始第一个 1. 先用代码给大家展示一下现象关于进程的替换一共有七个函数&…...

编程日记 2025/9/9 15:22:59

netty启用websocket的压缩机制

netty启用websocket的压缩机制 package com.aerotop.connector.websocket.base;import io.netty.channel.ChannelInitializer; import io.netty.channel.ChannelPipeline; import io.netty.channel.socket.SocketChannel; import io.netty.handler.codec.compression.JZlibDec…...

编程日记 2025/9/3 14:03:21

相关文章：