c-- c语言程序工具_doxygen

C语言项目必备:Doxygen注释规范全解析(附实战代码示例) 本文全面解析了C语言项目中Doxygen注释规范的应用,包括环境配置、基础工作流、注释规范详解及高级文档生成技巧。通过实战代码示例,帮助开发者提升代码可读性和维护效率,特别适合团队协作项目。 阅读详情

doxygen是API文档生成工具

安装和使用:

下载地址:https://www.doxygen.nl/download.html

安装一直next就可以。

打开后的界面:

使用:

选择好文件夹,然后 “Run dexygen”,就在选择的文件夹下生成html和latex文件夹。

html文件夹下,找到 index.html 文件打开。

latex文件夹没有看。

程序文件使用的是gb2312格式,输出后汉字会变成乱码。

没找到.c文件的在哪里,可能是没有配置完整,所以没有对.c文件进行处理,先不管了。

记录第一次使用,暂时用不到这个工具,也不知道用在什么地方。

样例:

opencv源码的说明文档 

OpenCV: OpenCV modules

 ROS源码说明:

actionlib: Main Page

参考资料: 文档生成神器---doxygen的使用和代码注释规范  文档生成神器---doxygen的使用和代码注释规范 - 古月居


 

C语言编程规范--代码注释 Doxygen是一个程序的文件产生工具,可将程序中的特定批注转换成为说明文件。通常我们在写程序时,或多或少都会写上批注,但是对于其它人而言,要直接探索程序里的批注,与打捞铁达尼号同样的辛苦。大部分有用的批注都是属于针对函式,类别等等的说明。所以,如果能依据程序本身的结构,将批注经过处理重新整理成为一个纯粹的参考手册,对于后面利用您的程序代码的人而言将会减少许多的负担。不过,反过来说,整理文件的工作对于您来说,就是沉重的负担。 阅读详情

相关推荐

STM32F103xx / STM32F429VET6最小系统原理图

心血来潮想试一下STM32F4系列和F1系列在编程上有什么差别,手头没有开发板,本着能勤俭节约的原则自己先做一块看看能不能成,看了一下STM32F429VET6的芯片在F429xx中最便宜,对照着数据手册绘制了原理图画了PCB,目前打板中,焊接完如果跑不通回来修改文章。这里我们可以看到,VDD是标准工作电压,VDDA是模拟工作电压,且VDDA必须与VDD等电位,VBAT是备份工作电压,一般接纽扣电池电源,如果存在VREF+引脚,则要求VDDA-VREF+ < 1.2V。截图下来比较糊,不知道为什么。

m0_51294753的博客 1万+

C语言中的Doxygen注释模板

目录一、文件注释,放于文件的开头二、文件注释,放于文件的开头三、文件注释,放于文件的开头三、文件注释,放于文件的开头三级目录 嵌入式C语言开发中通常使用Doxygen进行文档的生成。Doxygen支持多种格式,非常灵活,但排版不好就会显的比较杂乱,不便于阅读。下面给出一份注释模板。 一、文件注释,放于文件的开头 /** * @file * @brief This is a brief description. * @details This is the detail descr

胡图图 1万+

Pentaho安装与配置

Pentaho安装与配置前言一、下载二、配置1.JDK环境2.添加mysql-jdbc驱动三、启动 前言 Pentaho Data Integration (PDI):前身是Kettle。Pentaho提供了提取、转换和加载(ETL)功能,该功能使用统一且与最终用户和物联网技术相关且可访问的格式简化了捕获、清理和存储数据的过程。 功能:提供报表的制作、分析、仪表板、数据集成、数据采集、商业智能平台等强大功能。 一、下载 官网地址:http://www.pentaho.com/ 不过已经访问不到了

小太阳DENGJIE的博客 3619

C语言配置doxygen生成帮助文档

配置doxygen生成C语言帮助文档

^_^ 959

运行openclaw gateway install时出现Gateway install failed: Error: schtasks create failed的解决方案

本文主要介绍了运行openclaw gateway install时出现Gateway install failed: Error: schtasks create failed的解决方案,希望能对学习和使用openclaw的同学们有所帮助。 文章目录 1. 问题描述 2. 解决方案

weixin_43178406的博客 11万+

opencv案例实战——银行卡模式匹配识别

在之前的几篇文章中我们已经介绍了opencv的一些基础知识,本篇文章我们将结合一个案例运用之前的知识并且学习opencv中模式匹配的应用,用到的知识点如果有不清楚的可以查看上面列出来的系列文章。具体代码会放在最后。

艾醒的博客 1340

使用doxygen为C/C++程序生成中文文档(上)

使用doxygen为C/C++程序生成中文文档(上) 按照约定的格式注释源代码,用工具处理注释过的源代码产生文档。通过这种方式产生文档至少有以下好处: 便于代码和文档保持同步。 可以对文档做版本管理。 很多编程语言都有类似的文档工具,例如:Java有javadoc,Ruby有rdoc。对于C/C++程序,我们可以用Doxygen生成文档。本文通过为一个C++程序“谁养鱼”建...

技术代码资料库 777

为什么先进工艺需要check那么多corner?

那么hold slack = launch clock path delay + data path delay - capture_clock_path_delay = -capture_clock_path_delay,也就是说,capture clock path delay越大,hold越难满足。而且,我们在设计的时候,一般clock频率都会过约,所以是有较大的margin的。有的foundry还会对rc的取值范围进行了约束,如cworst_T,采用的是1.5 sigma的取值范围。

芯冰乐 2089

嵌入式C语言中的Doxygen注释模板

原文地址:http://blog.youkuaiyun.com/willerency/article/details/7083953  嵌入式C语言开发中通常使用Doxygen进行文档的生成。Doxygen支持多种格式,非常灵活,但排版不好就会显的比较杂乱,不便于阅读。下面给出一份注释模板。 一、文件注释,放于文件的开头 [cpp] view plaincopy /

yichi7758的专栏 2960

ArcGIS JS 态势标绘教程:直箭头(Straight Arrow)

ArcGIS JS 态势标绘教程:直箭头(Straight Arrow)。

非科班Java出身GISer的博客 711

蓝牙芯片驱动开发-第11章第1题-WiFi蓝牙共存的关键策略有哪些

蓝牙芯片驱动开发-第11章第1题-WiFi蓝牙共存的关键策略有哪些

weixin_42162924的博客 31

代码文档生成工具Doxygen教程及实例

程序员的很多文档,特别是有代码的文档,绝大部分都是由一款文档生成工具【Doxygen】生成。 什么是Doxygen? Doxygen 是一个程序的文件产生工具,可将程序中的特定批注转换成为说明文件。通常我们在写程序时,或多或少都会写上批注,但是对于其它人而言,要直接探索程序里的批注,与打捞铁达尼号同样的辛苦。 大部分有用的批注都是属于针对函式,类别等等的说明。所以,如果能依据程序本身的结构,将批注经过处理重新整理成为一个纯粹的参考手册,对于后面利用你的程序代码的人而言将会减少许多的负担。不过,反过来说,整.

qq_41854911的博客 1万+

假人有限元模型

假人模型,车辆碰撞假人有限元模型,适合做乘员安全的研究者利用

Doxygen 介绍和下载,安装

简介 Doxygen是一个程序的文档产生工具,可以将程序中的注释转换成说明文档或者说是API参考手册,从而减少程序员整理文档的时间。当然这里程序中的注释需要遵循一定的规则书写,才能让Doxygen识别和转化。 目前Doxygen可处理的程序语言包含C/C++、Java、Objective-C、IDL等,可产生出来的文档格式有HTML、XML、LaTeX、RTF等,此外还可衍生出不少其它格式; ...

黎国溥 1万+

VB摄像头监控

该VB模块可对摄像头捕获的画面进行录像等,可在创建的窗口进行控制

win10 跳过U8环境检测的IE WebControls.rar

win10 安装u8的时候 提示IE WebControls 不通过,这个工具可以欺骗u8的检查。 跳过U8环境检测的IE WebControls。提示导入失败后,重新检测通过。

java类可视化doxygen_Doxygen详细介绍(一)(Doxygen概述及本系列文章目录)

1 序言为代码写注释一直是大多数程序员有些困扰的事情。当前程序员都能接受为了程序的可维护性、可读性编码的同时写注释的说法,但对哪些地方应该写注释,注释如何写,写多少等这些问题,很多程序员仍然没有答案。更头痛的是写文档,以及维护文档的问题,开发人员通常可以忍受编写或者改动代码时编写或者修改对应的注释,但之后需要修正相应的文档却比较困难。如果能从注释直接转化成文档,对开发人员无疑是一种福音。而doxy...

weixin_39566387的博客 2354

老版QQ原生表情gif动态

这是老版的QQ表情,不过全是动态的的,Windows照片查看器是不会动的,可以右击用浏览器打开查看,再说一遍是老版的,只是分享给宁愿用老版也要动态的人。

Doxygen一个程序的文件产生工具

简介Doxygen 一.什么是Doxygen? Doxygen是一个程序的文件产生工具,可将程序中的特定批注转换成为说明文件。通常我们在写程序时,或多或少都会写上批注,但是对于其它人而言,要直接探索程序里的批注,与打捞铁达尼号同样的辛苦。大部分有用的批注都是属于针对函式,类别等等的说明。所以,如果能依据程序本身的结构,将批注经过处理重新整理成为一个纯粹的参考手册,对于后面利用您的程序代码的人而言将会减少许多的负担。不过,反过来说,整理文件的工作对于您来说,就是沉重的负担。 Doxygen就是在您写批..

327

代码注释规范之Doxygen

一 Doxygen简介 Doxygen是一个程序的文档产生工具,可以将程序中的注释转换成说明文档或者说是API参考手册,从而减少程序员整理文档的时间。当然这里程序中的注释需要遵循一定的规则书写,才能让Doxygen识别和转化。 目前Doxygen可处理的程序语言包含C/C++、Java、Objective-C、IDL等,可产生出来的文档格式有HTML、XML、LaTeX、RTF等,此外还可衍生出不少其它格式,如HTML可以打包成CHM格式,而LaTeX可以通过一些工具产生出PS或是PDF文档等。 二 Dox

ching的专栏 2973

文档生成工具-Doxygen使用方法以及注释规则

最近接触了一款程序 文档生成工具-Doxygen。在网上一搜索原来这么多人知道,打算把它的使用做一个总结,以及其注释的规则。 概述: Doxygen是一种开源跨平台的,以类似JavaDoc风格描述的文档系统,完全支持C、C++、Java、Objective-C和IDL语言,部分支持PHP、C#。注释的语法与Qt-Doc、KDoc和JavaDoc兼容。Doxgen可以从一套归档源文件开始,生成HTM...

零点开发的博客 2701

Doxygen使用教程1--安装配置

Doxygen简介 Doxygen 是一个程序的文件产生工具,可将程序中的特定批注转换成为说明文件。通常我们在写程序时,或多或少都会写上批注,但是对于其它人而言,要直接探索程序里的批注,与打捞铁达尼号同样的辛苦。大部分有用的批注都是属于针对函式,类别等等的说明。所以,如果能依据程序本身的结构,将批注经过处理重新整理成为一个纯粹的参考手册,对于后面利用您的程序代码的人而言将会减少许多的负担。不过,反...

yizhou2010的专栏 2257

简介Doxygen

什么是Doxygen? Doxygen 是一个程序的文件产生工具,可将程序中的特定批注转换成为说明文件。通常我们在写程序时,或多或少都会写上批注,但是对于其它人而言,要直接探索程序里的 批注,与打捞铁达尼号同样的辛苦。大部分有用的批注都是属于针对函式,类别等等的说明。所以,如果能依据程序本身的结构,将批注经过处理重新整理成为一个纯粹的参考手册,对于后面利用您的程序代码的人而言将会减少许多的负担。...

blogfeifei 223

C++-Doxygen简明注释语法

文章是转载的,因为年代太久远了,已经找不到原链接了 语法简介 Doxygen 是一个程序的文件产生工具,可将程序中的特定批注转换成为说明文件。提供了一套注释方式便于把代码中的注释生成说明文档。 很多开源项目都在使用,例如: wxWidgets clang 下面是常用的注释简介。 1. 简单注释 单行注释:///或者//! 多行注释:/**或者/*! 2. 文件注释 文件注释通常放在整个文件开头。 /** * @file 文件名 * @brief 简介 * @details 细节 * @m.

小马甲的新马甲 1414

windows linux cygen,linux c enum

安装doxygen 安装包 doxygen-1.7.4.linux.bin.tar.gz(可在官网下载)命令:1) tar xvfz doxygen-1.7.4.linux.bin.tar.gz2) cd doxygen-1.7.43) ./configure4) make5) make install安装后需留意下doxyg的路径,例如:/usr/bin/doxygen配置Doxygen工作环境...

weixin_39672979的博客 89

复古代码重生记:用现代C语言工具链重构尼科马彻斯定理验证器

本文详细介绍了如何将尼科马彻斯定理验证器从传统Turbo C环境迁移到现代VSCode+GCC工具链。通过分析数学原理、重构过时代码、配置跨平台开发环境,实现了定理验证算法的现代化和优化,确保代码在当代系统中的高效运行和长期可维护性。

tree的博客 701

DeepSeek-LLM Base 模型与 Chat 模型怎么选:一份基于评测数据的选型说明

结论先说:如果你的产出要直接给终端用户看——对话、客服、问答助手——选 DeepSeek-LLM 的 Chat 模型;如果你要拿模型继续做二次微调,或者任务只是纯文本补全这类非对话场景,选 DeepSeek-LLM 的 Base 模型。两者的本质区别在于训练流水线上的位置:Base 是纯预训练的产物,只学会了"预测下一个词";Chat 在 Base 之上又经过指令微调和安全对齐,学会了"按人类对话

gitblog_01032的博客 195

doxygen把stm32的代码转换成文档的教程(1)

doxygen把stm32的代码转换成文档的教程(1)一.doxygen的介绍Doxygen 是一个程序的文件产生工具,可将程序中的特定批注转换成为说明文件。通常我们在写程序时,或多或少都会写上批注,但是对于其它人而言,要直接探索程序里的批注,与打捞泰坦尼克号同样的辛苦。大部分有用的批注都是属于针对函数、类型等等的说明。所以,如果能依据程序本身的结构,将批注经过处理重新整理成为一个纯粹的参考手册,对

MENGHUANBEIKE的专栏 1251

【Doxygen】Doxygen使用教程(个人总结)

【Doxygen】Doxygen使用教程(个人总结) 简介Doxygen 引言.什么是Doxygen? Doxygen 是一个程序的文件产生工具,可将程序中的特定批注转换成为说明文件。通常我们在写程序时,或多或少都会写上批注,但是对于其它人而言,要直接探索程序里的批注,与打捞铁达尼号同样的辛苦。大部分有用的批注都是属于针对函式,类别等等的说明。所以,如果能依据程序本身的结构,将批注经过处理重新整理成为一个纯粹的参考手册,对于后面利用您的程序代码的人而言将会减少许多的负担。不过,反过来说,整理文件的工作对于您

qq_43331089的博客 5万+
上一篇: vim、sublime、notepad文本编辑器的使用
下一篇: STM32-- GPIO介绍、使用学习
code_snow
博客等级 码龄8年 316粉丝 171原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值