DOxygen for C++使用说明——注释代码二

最新推荐文章于 2025-07-08 10:04:47 发布
原创 最新推荐文章于 2025-07-08 10:04:47 发布 · 1.4k 阅读 · 2 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#doxygen

这一次我在谷歌搜索中检索到了Doxygen在github的仓库，进去一看，令人大喜，github仓库里含有了一个Doxygen的官方配置文件Doxyfile,于是下载下来，发现Doxyfile已经配置了将仓库中的\src文件编译成Documentation,并且将结果放在了doxygen_docs里面。如下图所示：


接着我们可以一边查看源代码，一边查看效果HTML，很快就可以熟悉Doxygen操作了。

我这里罗列了一些比较常用的用法。

  • 排版 

    关于排版，有两种格式比较常用，分别如下：

 

最低0.47元/天 解锁文章

200万优质内容无限畅学
Doxygen for C++使用说明——注释代码一
生如蚁，美如神
11-08 2058
写这一节的时候，我在想网上有众多的参考文献，外加官网上的，要是我再将它们重复一遍，也没什么意思。网上资料很多，但是他们有一个共同的缺点是都是罗列用法，然后显示效果。这些都是比较散的，我想是不是可以结合一个具体的范例来讲解Doxygen的用法呢？这样大家既可以学习到语法，也可以直接拿这个模板来用。 我自己在网上下了个模板，并且加了一些内容。这是显示效果链接。下面我将具体来介绍： 先看test.h.
doxygen 1.11.0 使用详解（四）——为代码写文档
no_xycoordinate的博客
05-22 1248
doxygen 1.11.0 使用详解（四）——为代码写文档
Doxygen代码注释规范
02-06
自己的编写的Doxygen代码注释规范，包括安装、使用和规范，很详细。可以直接生成.chm格式的注释文档，对于大型程序开发很有帮助。
doxygen的基本标注规则及实例
weixin_45687825的博客
10-21 2273
文章目录doxygen的基本标注规则及实例注释格式Doxygen常用注释命令Doxygen注释示例项目注释文件注释函数注释枚举、结构体等注释模块注释分组注释 doxygen的基本标注规则及实例 参考文章 注释格式 块注释建议统一使用 /** * comment */ 行注释建议统一使用 ///...comment... /** …… */ Doxygen常用注释命令 /** * @exception <exception-object> {exception description}
代码注释你写对了吗？ Doxygen 风格注释，一目了然!
最新发布
memoryfurong的博客
07-08 972
本文围绕 C/C++ 注释规范，介绍了 Doxygen 风格注释。先说明其是标准化格式，可生成结构化文档，支持多种语言，核心是特定标签。接着详细列出文档结构、函数方法等八类标签及使用提示。然后阐述使用方法，包括文件头部、类、函数等多种场景的注释要点与示例，还提及注释风格约定、禁忌及 C++ 特殊注意事项，最后提到相关工具链支持。
C++-Doxygen简明注释语法
小马甲的新马甲
01-28 1175
文章是转载的，因为年代太久远了，已经找不到原链接了 语法简介 Doxygen 是一个程序的文件产生工具，可将程序中的特定批注转换成为说明文件。提供了一套注释方式便于把代码中的注释生成说明文档。 很多开源项目都在使用，例如： wxWidgets clang 下面是常用的注释简介。 1. 简单注释 单行注释：///或者//! 多行注释：/**或者/*! 2. 文件注释 文件注释通常放在整个文件开头。 /** * @file 文件名 * @brief 简介 * @details 细节 * @m.
Doxygen的安装与配置及简单注释规范
热门推荐
奋斗Andy的博客
11-11 1万+
最近接触了一款程序 文档生成工具-Doxygen。在网上一搜索原来这么多人知道，打算把它的使用做一个总结，以及其注释的规则。 概述：  Doxygen是一种开源跨平台的，以类似JavaDoc风格描述的文档系统，完全支持C、C++、Java、Objective-C和IDL语言，部分支持PHP、C#。注释的语法与Qt-Doc、KDoc和JavaDoc兼容。Doxgen可以从一套归档源文件开始，
C/C++ 代码注释规范及 doxygen 工具
jucat的博客
07-07 2057
C++ 注释规范及 doxygen 配置和文档生成
doxygen全套工具——包括说明文档
11-17
标题"doxygen全套工具——包括说明文档"表明这是一份完整的doxygen工具包，其中不仅包含了doxygen的主要程序，还可能包括详细的使用教程和帮助文档，帮助用户理解和掌握如何使用doxygen来创建代码文档。 描述部分...
Doxygen从零学起———安装和配置
生如蚁，美如神
11-08 3930
Doxygen可以为多种语言生成说明文档（从程序的源代码中提取其中按照约定格式写的注释中提取信息） 例如C++, Objective-C, C#, C, PHP, Python, IDL (Corba, Microsoft, and UNO/OpenOffice flavors), Fortran, VHDL, Tcl, D ,从这期开始，我将系统地介绍Doxygen的使用，包括以下内容： Dox
C++标准注释原则 - 基于doxygen的C++注释
chizan3174的博客
05-12 394
标注总述 下载国外的源代码，往往能看到附带的说明文档，文档都有详细的说明，大部分文档都可以通过doxygen这个跨平台软件生成，doxygen并不能随便读取你的C++的注释,必须按照一定的规则才能生成，所以在编写代码时，一定要按照标准写注释，否则会为以后带来许多麻烦 下面介绍C+...
doxygen 注释规范
布袋和尚
11-08 2561
在你的注释中加入这样的代码。
Doxygen注释规范
wyxTech的专栏
02-01 1386
本文就简单的介绍一下doxygen的文档注释方法，以供初学者参考：    1. 模块定义（单独显示一页）  /*   * @defgroup 模块名 模块的说明文字   * @{   */     ... 定义的内容 ...    /** @} */ // 模块结尾  2. 分组定义（在一页内分组显示）  /*   * @name 分组说明文字   * @{  
基于Doxygen的C/C++注释原则
weixin_30360497的博客
08-22 1201
基于Doxygen的C/C++注释原则 标注总述 1.文件头标注 2. 命名空间标注 3. 类、结构、枚举标注 4. 函数注释原则 5. 变量注释 6. 模块标注 7. 分组标注 总述 华丽的分隔线 //--------------------------------------------------------------------------- // Pla...
C语言 - Doxygen代码注释规范
Matlab - Data_Reconstruction
04-21 5826
什么是Doxygen ； 他有什么作用？ Doxygen是一种开源跨平台的，以类似JavaDoc风格描述的文档系统，完全支持C、C++、Java、Objective-C和IDL语言，部分支持PHP、C#。注释的语法与Qt-Doc、KDoc和JavaDoc兼容。Doxgen可以从一套归档源文件开始，生成HTML格式的在线类浏览器，或离线的LATEX、RTF参考手册。 Doxygen 是一个程序的...
【工具】Doxygen代码注释规范
LYP_Tom的博客
05-29 2893
Doxygen文档注释规范
doxygen 注释规范_Doxygen的注释规则
weixin_39610366的博客
12-19 2933
Mike的分享空间Doxygen的注释规则date: 2015.05.04; modification:2015.05.04目录:1 注释模板1.1 头文件模板:/** @brief 摘要* @file 文件名* @author 作者* @version 版本号* @date 你啥时候搞的* @note 注解* @since 自从*/1.2 函数的注释:/*...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值