Doxgen文档注释：C++

最新推荐文章于 2024-07-07 21:10:32 发布
最新推荐文章于 2024-07-07 21:10:32 发布
阅读量2.3k 收藏 10
点赞数 1
分类专栏： C++/Qt 文章标签： chm 注释 c++
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/chlk118/article/details/53140250
版权
本文介绍了如何使用Doxgen为C++代码添加注释，并详细阐述了从文件注释到成员变量注释的规则。同时，详细讲解了Doxgen的安装、配置及生成CHM文件的步骤，包括设置编码、输出选项等，以生成中文文档。
摘要由CSDN通过智能技术生成

Doxgen的使用包括两个方面：
- 一个是代码的注释规则；
- 一个是利用doxgen生成相应的HTML和chm文件。

注释规则

文件注释

    /*!
    * @file   core.h 
    * @brief  核心类core
    * @author author
    * @date   2016-11-12                                                 
    */

函数注释

    /*!
     * @param  参数
     * @return 返回值
     * @see    参考对象
     * @note   说明
     */

类/结构体注释

最低0.47元/天 解锁文章
kestiny
关注
  • 1
    点赞
  • 踩
  • 10
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
doxygen注释规范示例（C++版）
u013639526的专栏
06-16 2348
源文件——函数注释
C/C++ doxygen注释示例
世事难料，保持低调
02-27 2731
/** * @file filename.h * @brief Brief description */ #include using namespace std; /** * A macro */ #define ABS(x) (((x)>0)?(x):-(x)
C/C++ 代码注释规范及 doxygen 工具
最新发布
jucat的博客
07-07 1224
C++ 注释规范及 doxygen 配置和文档生成
代码注释规范之Doxygen
ching的专栏
04-02 2395
一 Doxygen简介 Doxygen是一个程序的文档产生工具，可以将程序中的注释转换成说明文档或者说是API参考手册，从而减少程序员整理文档的时间。当然这里程序中的注释需要遵循一定的规则书写，才能让Doxygen识别和转化。 目前Doxygen可处理的程序语言包含C/C++、Java、Objective-C、IDL等，可产生出来的文档格式有HTML、XML、LaTeX、RTF等，此外还可衍生出不少其它格式，如HTML可以打包成CHM格式，而LaTeX可以通过一些工具产生出PS或是PDF文档等。 二 Dox
java注释
qq_45608338的博客
10-03 304
用于注解说明解释程序的文字就是注释。 Java中的注释类型：  单行注释  多行注释文档注释 (java特有) 提高了代码的阅读性；调试程序的重要方法。 注释是一个程序员必须要具有的良好编程习惯。 将自己的思想通过注释先整理出来，再用代码去体现 单行注释 格式： //注释文字 多行注释 格式： /* 注释文字 / 注： 对于单行和多行注释，被注释的文字，不会被JVM（java虚拟机）解释执行。 多行注释里面不允许有多行注释嵌套。 文档注释（Java特有） 格式：/* @
Doxgen的使用
热门推荐
ArenAK－－图形与编程
11-18 2万+
Doxgen是一个文档生成工具，一年前就注意了这个东西，只是一直没用，今晚闲着就把它捡起来，以后写完代码就用它了。Doxgen就是从你的代码中提取注释来生成供用户使用的说明文档，文档可以是各种格式，如html、rtf、xml等，不过我刚刚只是试验了html，感觉很不错。Doxgen很容易上手，不到两个小时的时间已经算初步掌握。利用Doxwizard GUI可以很方便的设置自己所需要的文档效
c++ doxygen 注释规范_利用Doxygen给C程序生成注释文档
weixin_36431195的博客
12-29 1485
利用Doxygen为C程序生成注释文档一、Doxygen工具的安装利用Doxygen工具生成API帮助文档需要下载安装以下三个软件：(1)Doxygen：可以从一套归档源文件开始，生成HTML格式的在线类浏览器，或离线的LATEX、RTF参考手册。本文中所使用的版本为：Doxygen-1.8.18.(2)Htmlhelp：该软件可以帮助您建立 HTML 格式的 HELP 文件。用于创建....
doxgen代码文档生成工具包
01-08
**doxygen** 是一款开源的文档生成系统，专门用于C++，但同时也支持其他编程语言，如C，C#，Java，Python等。它通过解析源代码中的注释来生成文档，让开发者可以轻松地了解代码结构和功能。doxygen-1.8.17-setup.exe...
doxdocgen：从VS Code中的源代码生成doxygen文档
02-01
通过启动Doxygen注释块并按Enter，此VS Code扩展可以即时生成Doxygen文档。 目录 产品特点 对准 有关其工作原理，请参见 属性 析构函数 广泛的定制 档案说明 功能指针 经营者 参量 退货类型 智能文字 支持的智能...
sourceinsight 便捷插件 符合Doxygen的注释标准
12-16
Doxygen注释标准是一种用于生成代码文档的规范，它允许程序员在代码中添加特殊的注释块，这些注释会被Doxygen解析并转化为结构化的文档。Doxygen支持多种注释格式，如Javadoc风格和Qt风格，使得代码的可读性和可维护...
doxygen完整示例
03-07
完整的如何使用Doxygen的例子,包括书写文档块,配置和生成的文档!
C++注释规范
08-31
对C++代码的注释种类，注释原则，规范细则进行了详细描述
doxygen使用说明文档
10-31
Doxygen 是一款非常强大的文档自动生成工具，尤其适用于 C++ 和其他多种编程语言。它能够帮助开发者根据代码注释自动生成各种形式的文档，如 HTML、LaTeX、RTF、PDF、CHM 等，便于团队成员之间进行交流和维护。通过 ...
程序文档生成工具-Doxygen
11-11
Doxygen是一种开源跨平台的，以类似JavaDoc风格描述的文档系统，完全支持C、C++、Java、Objective-C和IDL语言，部分支持PHP、C#。注释的语法与Qt-Doc、KDoc和JavaDoc兼容。Doxgen可以从一套归档源文件开始，生成HTML...
代码文档生成工具Doxygen教程及实例
qq_41854911的博客
04-29 9898
程序员的很多文档，特别是有代码的文档，绝大部分都是由一款文档生成工具【Doxygen】生成。 什么是Doxygen? Doxygen 是一个程序的文件产生工具，可将程序中的特定批注转换成为说明文件。通常我们在写程序时，或多或少都会写上批注，但是对于其它人而言，要直接探索程序里的批注，与打捞铁达尼号同样的辛苦。 大部分有用的批注都是属于针对函式，类别等等的说明。所以，如果能依据程序本身的结构，将批注经过处理重新整理成为一个纯粹的参考手册，对于后面利用你的程序代码的人而言将会减少许多的负担。不过，反过来说，整.
Doxygen给C程序生成注释文档
weixin_33895657的博客
05-28 859
　　 近段时间，一直在学习华为C语言编程规范（2011版），在“注释”这一章中发现了一种“Doxygen”的注释转文档工具，查看诸多相关资料，并进行编程实践，终于可以利用Doxygen给C程序生成注释文档。在使用过程中，我已经深深地喜欢Doxygen，并在写代码时使用Javadoc注释风格。 　　本文由三部分组成：1）工具下载及安装；2）编写Doxygen可识别的注释；3）利用Doxygen工具...
Doxygen的使用、配置及实例
xiaoma_bk的博客
07-13 1447
1.简介 Doxygen是一种开源跨平台的，以类似JavaDoc风格描述的文档系统，可以从一套归档源文件开始，生成API文档的工具。 Doxygen是一个程序的文档产生工具，可以将程序中的注释转换成说明文档或者说是API参考手册，从而减少程序员整理文档的时间。当然这里程序中的注释需要遵循一定的规则书写，才能让Doxygen识别和转化。 总结：Doxygen 就是在您写批注时，稍微按照一些它所制...
doxgen中插入图片
05-18
2. 使用以下格式在 Doxygen 注释中插入图片： ``` \image ``` 其中 `<file_name>` 是图片的文件名。 例如，要插入名为 `example.png` 的图片，可以使用以下代码： ``` /** * @brief This is an example...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值