C语言项目必备:Doxygen注释规范全解析(附实战配置步骤)

Doxygen注释 基于嵌入式C实战化快速入门 将相关的代码元素(如函数、宏、结构体、文件)组织成一个逻辑模块或组。这对于大型嵌入式项目按功能划分文档非常有用。<name>: 模块的唯一标识符(不包含空格,通常用下划线连接)。Doxygen 内部使用。<title>: 模块在文档中显示的标题。name: 模块的内部名称。title: 模块的显示名称。/*** @defgroup TIMER_MODULE 定时器管理模块* @brief 提供微控制器定时器相关的初始化、中断和延迟功能。 阅读详情

C语言项目必备:Doxygen注释规范全解析(附实战配置步骤)

在C语言项目的长期演进中,代码的可维护性和团队协作效率,往往与文档的质量直接挂钩。我们都有过这样的经历:接手一段数月甚至数年前的代码,面对那些精妙却晦涩的函数和结构体,如果没有清晰的说明,理解其意图无异于破解一段密码。而一份与代码同步、自动生成、格式统一的技术文档,正是破解这道难题的钥匙。这不仅仅是“锦上添花”,对于追求工程卓越的团队而言,它是保障项目健康度的基础设施。

Doxygen正是这样一把强大的钥匙。它并非简单的注释提取器,而是一个成熟的文档生成系统,能够将你按照特定规则书写的代码注释,转化为结构清晰、可导航的HTML网页、PDF手册,甚至是CHM帮助文件。想象一下,新成员入职后,无需你口述,他们就能通过浏览器查阅整个项目的模块划分、接口定义和数据结构,甚至能看到函数调用关系图——这极大地降低了知识传递的成本。本文将从一个实战者的视角,而非工具手册的翻版,为你深入解析如何将Doxygen无缝集成到你的C语言工作流中。我们会从核心的注释哲学讲起,一步步拆解配置细节,并分享那些只有踩过坑才知道的实用技巧,目标是让你在项目结束时,收获的不仅是一份可执行的程序,还有一份专业、可传承的项目文档。

1. 理解Doxygen:超越注释的文档工程

很多开发者对Doxygen的第一印象是“一种注释格式”,这其实低估了它的价值。更准确地说,Doxygen是一套基于语义的文档化工作流。它要求你在编写代码的同时,以一种机器可读(同时也是人可读)的方式,描述代码元素的意图、约束和行为。这个过程迫使你进行更深层次的思考:这个函数的边界条件是什么?那个结构体字段的单位是什么?这个全局变量为什么必须是静态的?

这种“代码即文档”的理念,与良好的软件设计原则是相辅相成的。当你试图为一个糟糕设计的函数撰写清晰的Doxygen注释时,你往往会发现这个函数本身的责任过于模糊或耦合度过高,从而促使你去重构它。因此,采用Doxygen的过程,也是一个持续改善代码设计的过程。

Doxygen支持多种输出格式,最常用的是HTML,因为它便于在线浏览和搜索。对于需要离线分发的场景,它可以生成LaTeX进而编译为精美的PDF,或者生成Windows平台标准的CHM帮助文件。它还能与Graphviz工具结合,自动绘制函数调用图、继承关系图等,让复杂的模块依赖关系一目了然。

提示:不要试图在项目后期才“补”Doxygen注释。那将是一项枯燥且容易出错的重体力劳动。最佳实践是在编写或修改每一处代码的同时,就完成对应的注释更新,使其成为开发流程中自然而然的一环。

2. 注释规范精讲:写出有灵魂的代码说明

Doxygen的注释规范是其核心,掌握它意味着你掌握了与Doxygen“对话”的语言。规范的注释不仅能生成文档,更能提升代码本身的可读性。

2.1 基础注释语法与文件级文档

Doxygen主要识别两种格式的注释块:

  • Javadoc风格:以 /** 开始,以 */ 结束。这是最推荐、也最通用的格式。
  • Qt风格:以 /*! 开始。与Javadoc风格功能相同,可根据团队习惯选择。

对于文件头注释,它应该像一本书的扉页,告诉读者这个源文件的基本信息。一个完整的文件头注释模板如下:

/**
 * @file    network_manager.c
 * @brief   网络连接管理与数据收发核心模块。
 *          负责TCP/UDP套接字生命周期、数据包封装解析及断线重连逻辑。
 *
 * @author  张三
 * @version 1.2
 * @date    2023-10-27
 *
 * @note    本模块线程不安全,请在单线程上下文或外部加锁后调用。
 * @warning 内部使用了阻塞式套接字操作,请勿在实时性要求极高的主循环中直接调用。
 * @see     参考 `protocol_parser.h` 进行数据包解析。
 */

这个注释块使用了多个Doxygen命令(以@开头的关键词):

  • @file:声明当前文件名,这是生成文档索引的关键。
  • @brief:提供文件的简短摘要,会显示在目录列表中。
  • @author, @version, @date:提供元信息。
  • @note, @warning:给出重要的使用须知和警告。
  • @see:建立到其他相关模块的交叉引用。

2.2 函数与结构体注释实战

函数是逻辑的载体,其注释应清晰说明意图、行为、参数及返回值。

/**
 * @brief  从环形缓冲区中读取指定长度的数据。
 *
 * 此函数会从缓冲区消费者索引处开始,连续读取 `len` 字节的数据到用户提供的缓冲区。
 * 如果缓冲区中可用数据不足,则读取所有可用数据并返回实际读取的字节数。
 * 该操作是线程安全的,但同一时间只允许一个读者或一个写者。
 *
 * @param[in]  ringbuf  指向已初始化的环形缓冲区结构体的指针。
 * @param[out] data     用户提供的输出缓冲区指针,用于接收读取的数据。
 * @param[in]  len      期望读取的数据长度(字节)。
 *
 * @return              实际成功读取的字节数。
 * @retval  >=0         成功读取的字节数。
 * @retval  -1          输入参数非法(如 `ringbuf` 或 `data` 为 NULL)。
 * @retval  -2          缓冲区未初始化。
 *
 * @note    函数内部会移动消费者索引,读取操作是“消耗性”的。
 * @warning 用户必须确保 `data` 指向的缓冲区长度至少为 `len`,否则会导致内存越界。
 * @see     ringbuf_write(), ringbuf_init()
 */
int ringbuf_read(struct ring_buffer *ringbuf, void *data, size_t len);

关键点解析:

  1. @param[in/out]:明确参数方向。[in]表示输入,[out]表示输出,[in,out]表示既输入又输出。这比单纯用@param提供了更多语义信息。
  2. @return 与 @retval:@return描述返回值的一般含义,@retval则用于枚举具体的返回值及其对应的意义,使文档非常精确。
  3. 上下文关联:通过@see将本函数与相关的初始化、写入函数链接起来,方便读者跳转查阅。

对于结构体、枚举和全局变量,注释同样重要。

/** 传感器数据包结构体 */
typedef struct {
    uint32_t timestamp;   /**< 数据采集的时间戳,单位:毫秒 */
    float    temperature; /**< 温度读数,单位:摄氏度 */
    float    humidity;    /**< 湿度读数,单位:百分比 */
    uint8_t  sensor_id;   /**< 传感器硬件ID,范围 0-255 */
} sensor_data_t;

/** 系统运行状态枚举 */
typedef enum {
    SYS_STATE_INIT,    /**< 系统初始化中 */
    SYS_STATE_RUNNING, /**< 系统正常运行 */
    SYS_STATE_ERROR,   /**< 系统发生错误 */
    SYS_STATE_SLEEP    /**< 系统低功耗睡眠 */
} system_state_t;

注意对于结构体成员和简单变量,我们使用了行尾注释 /**<。这是Doxygen特有的语法,表示注释作用于左侧的标识符,非常简洁。

2.3 高级指令与模块化分组

当项目规模变大时,你需要对文档进行组织。@defgroup 和 @ingroup 指令可以帮助你创建模块分组。

例如,在项目的一个头文件 network.h 中定义网络模块组:

/**
 * @defgroup network_module 网络通信模块
 * @brief   所有与网络套接字、连接、数据收发相关的API。
 * @{
 */

/* 函数和结构体声明 */

/** @} */ // 结束 network_module 分组

然后,在具体的实现文件 tcp_client.c 中,将相关函数归入该组:

/**
 * @ingroup network_module
 * @brief 建立TCP连接到指定服务器。
 */
int tcp_connect(const char* host, int port);

这样,在生成的HTML文档中,会出现一个独立的“网络通信模块”页面,里面集中了所有归属于该模块的API。

3. 从零开始:Doxygen图形化配置详解

理解了注释规范后,我们需要让Doxygen工作起来。虽然Doxygen有命令行工具,但对于初学者和大多数日常使用场景,其图形化前端工具 Doxywizard 是更友好的选择。下面我们一步步进行配置。

3.1 基础项目设置

运行Doxywizard,你会看到几个主要的配置选项卡。首先关注 “Wizard” > “Project” 部分。

配置项推荐设置与说明
Project name你的项目名称,如“智能设备嵌入式固件”。这会成为文档的标题。
Project synopsis项目简短描述,一两句话概括。
Source code directory点击浏览,选择你的C项目源代码的根目录。这是最关键的一步。
Scan recursively务必勾选。这样Doxygen会扫描源代码目录下的所有子文件夹。
Destination directory选择生成的文档输出目录。建议新建一个如 ./docs 的文件夹,与源代码分离。

接着,在 “Wizard” > “Mode” 中:

  • Select the extraction mode:选择 All entities。这样它会为所有代码实体(包括未显式注释的)生成文档,未注释的部分会生成骨架,提醒你去补充。
  • Select programming languages:在“Optimize for”下拉菜单中,选择 C。这能确保解析器针对C语言的特性进行优化。

3.2 输出格式与图表生成

切换到 “Wizard” > “Output”。

  • 通常我们至少需要HTML输出,所以确保 HTML 被勾选。如果你需要为Windows用户生成帮助文件,可以同时勾选 CHM。
  • LaTeX 用于生成PDF,如果你需要印刷级排版的文档可以勾选,但配置稍复杂。

图表(Diagrams) 是Doxygen的一大亮点。在 “Wizard” > “Diagrams” 中:

  • 确保选中 Use dot tool from the GraphViz package。
  • 在下方选择 HAVE_DOT,这样才能启用图表生成功能。

注意:你需要预先从GraphViz官网下载并安装GraphViz软件,并将其 bin 目录添加到系统的PATH环境变量中,Doxygen才能调用 dot 命令。

3.3 专家模式下的关键调优

“Expert”选项卡提供了更精细的控制。这里有几个影响生成结果的重要设置:

在 “Expert” > “Project” 中:

  • OUTPUT_LANGUAGE:设置为 Chinese,这样生成的导航菜单、标题等会是中文。但注意,你注释本身的内容语言不受此影响。
  • TAB_SIZE:设置为 4。这能确保文档中代码块的缩进与你的编辑器设置一致。

在 “Expert” > “Build” 中,以下设置决定了文档的“详细程度”:

  • EXTRACT_ALL:设置为 YES。这样即使某个函数没有写Doxygen注释,它也会出现在文档中(但只有原型没有描述),这有助于你检查文档覆盖率。
  • EXTRACT_PRIVATE 和 EXTRACT_STATIC:根据需求设置。如果你希望内部静态函数和私有(在C中可能指static全局函数/变量)也出现在文档中,就设为 YES。
  • HIDE_UNDOC_MEMBERS:如果设为 YES,那么没有文档的成员将不会显示。在项目初期,建议设为 NO 以看到全貌。

在 “Expert” > “Input” 中:

  • INPUT_ENCODING:至关重要! 必须设置为你的源代码文件的字符编码。如果源代码是UTF-8(推荐),就设为 UTF-8;如果是GB2312,则设为 GB2312。设置错误会导致中文注释乱码。

在 “Expert” > “HTML” 中(如果你生成CHM):

  • GENERATE_HTMLHELP:如果前面勾选了CHM,这里会自动设为 YES。
  • CHM_FILE:可以设置生成的CHM文件名,如 MyProject.chm。
  • HHC_LOCATION:需要指向HTML Help Workshop编译器 hhc.exe 的完整路径,例如 C:\Program Files (x86)\HTML Help Workshop\hhc.exe。你需要单独安装HTML Help Workshop。

在 “Expert” > “Dot” 中:

  • CLASS_DIAGRAM:设为 YES 以生成类图(对C语言主要是结构体关系图)。
  • CALL_GRAPH 和 CALLER_GRAPH:强烈建议设为 YES。它们会为每个函数生成调用图和被调用图,对于理解代码流程极有帮助。
  • DOT_IMAGE_FORMAT:可以选择 svg(矢量图,清晰但某些旧浏览器不支持)或 png(位图,兼容性好)。根据你的需求选择。

4. 生成、排查与集成:让文档工作流自动化

配置完成后,点击 “Run” 选项卡,然后点击 Run doxygen 按钮。Doxywizard会调用后台的doxygen引擎处理你的源代码。

4.1 处理常见警告与错误

生成过程中,输出窗口会显示大量信息。你需要关注的是 警告(Warnings) 和 错误(Errors)。

  • 未文档化的参数警告:这是最常见的警告,提示你某个函数的某个参数缺少@param描述。你应该根据警告信息定位到具体代码行进行补充。
  • 编码错误:如果出现中文乱码,请回头检查 INPUT_ENCODING 和源代码文件的实际编码是否一致。可以用诸如VS Code、Notepad++等编辑器查看并转换文件编码。
  • CHM生成错误:如果提示找不到 hhc.exe,请确认 HHC_LOCATION 路径是否正确,以及HTML Help Workshop是否已安装。

4.2 保存配置与自动化脚本

配置一次后,你肯定不想每次重新设置。在Doxywizard中,通过 File -> Save 可以将当前所有配置保存为一个 Doxyfile 文件。这个文件是一个纯文本的配置文件,包含了所有你设置的选项。

有了 Doxyfile,你就可以脱离图形界面,在命令行或脚本中运行文档生成:

doxygen Doxyfile

这为自动化集成打开了大门。你可以将这条命令写入项目的构建脚本(如Makefile、CMakeLists.txt或CI/CD流水线)中,使得每次编译发布版本时,自动生成最新的技术文档。

4.3 文档风格定制与主题

默认生成的HTML文档风格比较朴素。Doxygen支持使用自定义的CSS样式表或第三方主题来美化输出。你可以通过修改 “Expert” > “HTML” 中的 HTML_EXTRA_STYLESHEET 选项,指向你自己的CSS文件。网络上也有许多开源的精美Doxygen主题(如doxygen-awesome-css),下载后简单配置即可大幅提升文档的视觉体验。

最后,别忘了将生成的 docs 目录(或你指定的输出目录)添加到你的版本控制系统(如Git)中。这样,代码的每一个版本都有与之完全匹配的文档快照,回溯和对比将变得非常容易。在实际项目中,我习惯将文档生成作为 make doc 命令,团队成员只需简单执行即可获得最新、最全的项目API手册,这几乎消除了因接口理解不一致而导致的低级协作错误。

C语言 - Doxygen代码注释规范 什么是Doxygen ; 他有什么作用? Doxygen是一种开源跨平台的,以类似JavaDoc风格描述的文档系统,完全支持C、C++、Java、Objective-C和IDL语言,部分支持PHP、C#。注释的语法与Qt-Doc、KDoc和JavaDoc兼容。Doxgen可以从一套归档源文件开始,生成HTML格式的在线类浏览器,或离线的LATEX、RTF参考手册。 Doxygen 是一个程序的... 阅读详情

相关推荐

C语言项目必备:Doxygen注释规范全解析(附实战代码示例)

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

l3m4n的博客 875

代码注释规范之Doxygen

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

ching的专栏 2973

VSCode+Doxygen注释模板终极配置指南(附完整Snippet代码)

本文详细介绍了如何在VSCode中配置Doxygen注释模板,提供完整的Snippet代码,帮助开发者快速生成规范的代码注释。从基础环境准备到高级定制技巧,涵盖文件头注释、函数注释、类与结构体模板等实用配置,大幅提升团队协作效率和代码可维护性。

orange的博客 337

doxygen常用代码注释标记示例说明

目录类、结构体公有函数、全局函数枚举公有成员变量、全局常量常见问题如何在注释文件中添加表格如何在注释中分条列举如何给描述内容分段Doxygen 常用的代码注释标记介绍 类、结构体 类和结构体的描述必须包含“所属类别(group)”以及“显示表示简要描述(brief)” 说明: 隐式区分简要描述和详细描述: 默认会先判断第一行为简易说明,这个简易说明将一直到遇见一个空白行的出现为止; 之后的注解将会被视为详细说明。 显式区分简要描述和详细描述: 指定@brief 的指令,这将会明确的告诉 Doxygen 哪

bigchen 8956

VSCode+Doxygen注释模板终极配置指南:从文件头到函数注释一键生成

本文详细介绍了如何在VSCode中配置Doxygen注释模板,实现从文件头到函数注释的一键生成。通过智能插件和代码片段功能,开发者可以轻松创建规范的代码文档,提升团队协作效率和项目可维护性。文章涵盖了环境准备、文件头注释自动化、函数注释智能生成等核心内容,并提供了高级注释技巧与团队规范建议。

y7z8a的博客 275

告别手动注释:用VSCode和Doxygen自动化生成专业级API文档

本文详细介绍了如何利用VSCode和Doxygen自动化生成专业级API文档,告别繁琐的手动注释工作。通过环境配置、注释规范、Doxygen深度配置和自动化工作流集成,帮助开发团队提升文档质量和维护效率,特别适合大型代码库和开源项目。

weixin_28826961的博客 360

Doxygen注释规范

0x20000000/*** @defgroup 定义log的级别* @{* @}*/0123/*** @defgroup 定义log的级别* @{* @}*//*** @param data 参数说明* @param len 参数说明/*** @param data 参数说明* @param len 参数说明/*** @param data 参数说明* @param len 参数说明/*** @param data 参数说明* @param len 参数说明。

weixin_67003440的博客 3113

VSCode+Doxygen快速生成代码文档:从安装到配置的完整指南

本文详细介绍了如何使用VSCode和Doxygen快速生成代码文档,从环境配置到高级工作流集成的完整指南。通过自动化工具链搭建、注释规范实践和CI/CD集成,帮助开发者提升文档编写效率,特别适合中大型项目和团队协作场景。

weixin_28831341的博客 459

Doxygen 文档注释详解

转自:http://hi.baidu.com/seest/blog/item/efb5264cd21a4dfad72afc02.html 用 Doxygen 自动生成文档大家在平时的编程过程中,都会在代码中插入一些注释,对文件,类,函数,全局变量等进行简单说明.项目完成后,一般也要编写项目的...

chenqunan3231的博客 102

VSCode结合Doxygen实现高效代码文档自动化

本文详细介绍了如何在VSCode中集成Doxygen,搭建高效的代码文档自动化工作流。通过安装核心插件、编写符合规范的注释,并配置Doxyfile,开发者可以一键生成结构清晰、包含图表和交叉引用的专业文档。该方法能显著提升团队协作效率和代码可维护性,实现文档与代码的同步更新。

weixin_28837817的博客 230

保姆级教程:用torch.profiler给你的vLLM推理做个“全身体检”(附Perfetto可视化分析)

本文提供了一份详细的vLLM推理性能分析教程,通过torch.profiler和Perfetto工具链实现从数据采集到可视化分析的全流程。文章涵盖了环境配置、性能数据采集、trace文件解析以及Perfetto可视化分析,帮助开发者优化大模型推理服务的性能,显著降低计算资源消耗。

weixin_29041767的博客 359

VSCode 高效配置 Doxygen 注释模板与智能代码片段

本文详细介绍了如何在VSCode中高效配置Doxygen注释模板与智能代码片段,提升代码文档的规范性和开发效率。通过安装必备插件、基础配置示例和高级定制技巧,开发者可以一键生成统一风格的注释,并利用智能代码片段快速插入常用注释块。文章还分享了函数注释的最佳实践和团队协作的注意事项,帮助团队提升代码可读性和维护性。

beta5的博客 200

嵌入式开发实战:LWIP中PPP协议配置全流程(含CHAP认证避坑指南)

本文是一份嵌入式开发实战指南,详细解析了如何在STM32平台上配置LWIP协议栈中的PPP协议,实现从串口到IP网络的完整连接。内容涵盖工程搭建、源码整合、关键配置、串口驱动绑定、状态管理以及CHAP认证等核心流程,并重点提供了CHAP认证失败的排查与避坑指南,帮助开发者高效打通嵌入式设备的网络连接。

plant的博客 464

C++ 程序文档生成器(doxygen)使用说明

可以在注释中加一些Doxygen支持的指令,主要作用是控制输出文档的排版格式,使用这些指令时需要在前面加上“\”或者“@”(JavaDoc风格)符号,告诉Doxygen这些是一些特殊的指令,通过加入这些指 令以及配备相应的文字,可以生成更加丰富的文档,下面对比较常用的指令做一下简单介绍。需要在c/c++代码中按照下面的风格添加注释,基本上还是很顺手的C++的注释风格 主要使用下面这种样式:即在注释块开始使用三个反斜杠‘/’对需要的类增加注释,需要 说明类的设计方法,类的使用指南,说明类的不变项。

PHP代码的博客 4874

Reality Capture控制点修复/合并模型

通过增加控制点/修改对齐设置参数来修复模型被分为两个部分的解决方法

草履虫建模的博客 5259

Cisco Packet Tracer实战:三层交换机链路聚合配置全流程(附常见错误排查)

本文详细解析了在Cisco Packet Tracer环境中配置三层交换机链路聚合的全流程,包括基础网络设置、LACP协议配置、路由协议集成及高级优化技巧。通过实战案例和常见错误排查指南,帮助网络工程师和CCNA备考学员掌握这一提升带宽利用率和实现链路冗余的核心技术。

grafana6viz的博客 233

【前端开发必备技能】:深入解析VSCode块注释的高级应用场景

掌握VSCode注释块注释技巧,提升前端开发效率。详解多行注释、代码折叠与模板快捷键,适用于函数说明、模块文档等场景,支持快速导航与团队协作。操作便捷,结构清晰,值得收藏。

ByteVein的博客 737

用STM32F103单片机控制电调制动无刷电机

用电调控制无刷电机制作遥控飞艇 蓝牙控制 调控电调 无刷电机 用电调控制无刷电机制作遥控飞艇 代码区 mian.c #include "delay.h" #include "sys.h" #include "usart.h" #include "usart3.h" #include "timer.h" #include "led.h" #include "key.h" int main(v...

子非鱼 的博客 2万+

C/C++文档注释神器——Doxygen常用知识整理(持续更新)

C/C++文档注释神器——Doxygen常用知识整理(持续更新) 分类: C++2010-04-14 20:48 772人阅读 评论(0) 收藏 举报 Doxygen是什么 Doxygen 是一种开源跨平台的,以类似JavaDoc风格描述的文档系统,完全支持C、C++、Java、Objective-C和IDL语 言,部分支持PHP、C#。注释的语法与Qt-Doc、KDoc和J

j6915819的专栏 4853

整理笔记——二极管

二极管是一种由半导体材料制成的一种具有单向导电性能的电子元器件,二极管的核心是PN结。加在二极管两端的电压和通关的电流被成为,二极管的伏安特性曲线​​​二极管的正向特性:起初正向电压较小时,正向电流几乎没有,称之为死区,此时二极管处于截止状态。当电压差超过截止电压(0.5V或者0.7V),电流随着电压上升,开始增加缓慢,随后急剧增大,二极管的电阻变小进入导通状态,此时电压变化较小。二极管的反向特性:起初反向电流很小,不随电压二变化,此时成为反向饱和电流;当方向电压达到二极管的反向击穿电压。

#include 811

从零开始玩转机械臂:用Matlab+Robotics Toolbox实现四自由度机械臂运动仿真

本文详细介绍了如何利用Matlab及其Robotics Toolbox工具箱,从零开始构建并仿真一个四自由度机械臂。通过D-H参数建模、正向运动学验证、交互式操控以及轨迹规划等实践步骤,帮助初学者在虚拟环境中直观理解机器人运动学核心概念,为后续硬件实现奠定坚实基础。

weixin_29055699的博客 326

Doxygen简单经验谈。。。

Doxygen简单经验谈。。。 Doxygen,大名鼎鼎的文档生成工具,被Boost、OpenCasCade等诸多项目作为文档生成的不二人选。人说,才华横溢往往是高深莫测,这句话放在 Doxygen这里显然是不适用的。十八般武艺样样精通的Doxygen,却十分的简单易用,从头到尾看一下它随机的文档,想不会用都难。。。嫌看英文麻烦的,这里有一篇中文的入门介绍。简单的说,如果你准备在项目中采用Do

wangzhengqianw的专栏 1069

C语言实现惯性导航初始对准全部核心代码

惯性导航初始对准包括间接粗对准和卡尔曼滤波精对准,其中。为基于卡尔曼滤波的精对准,其中。

十八与她的博客 2284

Open3D文档自动化生成终极指南:从源码注释到精美文档的完整方案

Open3D作为现代3D数据处理库,其文档系统展现了开源项目文档自动化的专业实践。开发者通过Doxygen和Sphinx的深度集成,实现了从源码注释到多格式文档的自动化流水线,大幅提升了代码可维护性和用户体验。 ## 🚀 文档自动化:现代开源项目的必备能力 在大型3D项目中,手动维护文档不仅耗时费力,还容易导致文档与代码脱节。Open3D采用了一套完整的自动化文档生成方案,将C++源码注释、

gitblog_00178的博客 742

Probability and Statistics - 4th edition

Probability and Statistics - 4th edition

假人有限元模型

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

上一篇: Firefly III + Docker Compose:5分钟搞定个人财务管理系统(附常见错误排查)
下一篇: Windows环境下彻底卸载Ninja的三种方法及常见问题解决
git9versioner
博客等级 码龄4年 75粉丝 1650原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符  | 博主筛选后可见
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明:

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

余额充值