Doxygen:安装与使用

本文档详细介绍了Doxygen的配置安装步骤,并提供了Doxygen常用命令的解析,包括文件信息、模块信息、函数信息及提醒信息等。此外,还指导如何将生成的静态网页托管到GitHub上,包括GitHub账户注册、仓库创建、Git操作等步骤。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

           本篇博客记录一些从网上收缴来的资源。包括配置安装过程,以及Doxygen文档命令的一些写法。最后详细讲解一个将生成的静态网页托管到github上的过程。


      一、 配置安装过程见以下文章::

                         用doxygen+graphviz自动化生成代码文档


      二、常见的Doxygen命令:

          文档中的命令都开始于一个反斜杠(\)(Qt风格)或者是一个at-符号(@)(java风格)

    1 文件信息
        1) \file 文件名(遵守文件命名规则) --> 文件声明,即当前文件名
        2) \author 作者名 --> 作者
        3) \version 版本号 --> 版本号
        4) \todo 说明文字 --> TODO 列表,在相关页面有它专门一项
       注:只能在实现文件(*.c/*.cpp)中使用,
     如果相同函数的实现文件与头文件中均有,生成的文档中会有重复项,
    可以理解为调用者不应知道实现流程。
       5) \date 日期时间 --> 说明文件生成的日期时间
       6) \section 章节标题 --> @section LICENSE 版权许可 @

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值