Doxgen文档注释：C++

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

#chm #注释 #c++

本文介绍了如何使用Doxgen为C++代码添加注释，并详细阐述了从文件注释到成员变量注释的规则。同时，详细讲解了Doxgen的安装、配置及生成CHM文件的步骤，包括设置编码、输出选项等，以生成中文文档。

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

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

注释规则

文件注释

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

函数注释

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

类/结构体注释
最低0.47元/天 解锁文章

200万优质内容无限畅学
doxygen注释规范示例（C++版）
u013639526的专栏
06-16 2434
源文件——函数注释
Doxygen生成注释文档
热门推荐
不咸不要钱
12-06 1万+
最终效果 最终通过文件的注释，生成一个帮助文档。 软件安装 需要安装3个软件 1.Doxygen 2.graphviz(可以根据文件的引用关系生成调用关系图) 3.htmlhelp（生成windos脱机可用的帮助文档） 打包地址 链接：. 提取码：c98c 自行默认安装即可 注释规范 想要生成注释文档，首先你的注释要符合Doxygen的要求 文件注释 /*! * @file LQ_C...
C/C++ doxygen注释示例
世事难料，保持低调
02-27 2792
/** * @file filename.h * @brief Brief description */ #include using namespace std; /** * A macro */ #define ABS(x) (((x)>0)?(x):-(x)
28. Java 注释与文档注释
最新发布
weixin_43484713的博客
05-24 1178
Java注释是代码中的说明性文字，用于提高可读性和维护性，主要包括单行注释（//）、多行注释（/* */）和文档注释（/** */）。单行注释适合简短说明或临时调试，多行注释用于详细解释代码块，文档注释则能生成API文档。注释应避免过度使用，及时更新，并遵循规范。单行注释需注意仅对当前行有效，避免冗余说明，并与代码对齐保持整洁。合理使用注释能有效辅助代码理解和团队协作。
代码注释规范之Doxygen
To the beyond and infinity!
09-07 3250
Doxygen是一个程序的文档产生工具，可以将程序中的注释转换成说明文档或者说是API参考手册，从而减少程序员整理文档的时间。当然这里程序中的注释需要遵循一定的规则书写，才能让Doxygen识别和转化。目前Doxygen可处理的程序语言包含C/C++、Java、Objective-C、IDL等，可产生出来的文档格式有HTML、XML、LaTeX、RTF等，此外还可衍生出不少其它格式，如HTML可以打包成CHM格式，而LaTeX可以通过一些工具产生出PS或是PDF文档等。
AtomineerUtils712：Visual Studio中的Doxgen风格注释插件
传统的手写代码注释方式既耗时又容易出错，而AtomineerUtils712插件可以自动根据代码的结构和命名规则，生成标准化的文档注释模板。 ### 知识点三：Doxgen风格注释特点 Doxgen风格的注释采用特定的标记和格式来...
基于Doxygen的C/C++注释原则
YZ_51的博客
06-20 978
基于Doxygen的C/C++注释原则 标注总述 1.文件头标注 2. 命名空间标注 3. 类、结构、枚举标注 4. 函数注释原则 5. 变量注释 6. 模块标注 7. 分组标注 总述 如果你使用大多数国内公司使用的编程规范 则遵守以下规则： 1、缩进使用4个空格，不要使用tab 2、独立的程序块之间、变量说明之后必须加空行，如 int tmp; tmp = MAX_NUM; 3、不要在程序内...
Doxygen C/C++代码注释基本语法
jgp886585的博客
01-16 1798
该文译自Doxygen官方文档，仅作为学习规范自己代码之用，内容有增删，个人水平有限，难免有所错漏，欢迎指正，谢谢！
QT doxgen 注释
03-31
根据引用[4]，C++程序员通常使用三个斜杠///作为行注释，这可能更适合Qt代码。此外，Qt中的类通常继承自QObject，并使用特定的宏，如Q_PROPERTY，这些可能需要文档说明。 接下来，用户需要示例，所以得准备几个常见...
Doxygen 注释 | 编程规范
科研小白一枚~ 愿上天不会辜负每一个努力的菜鸟！
08-15 1260
Doxygen 是一个功能强大的文档生成工具，可以帮助你从代码中提取注释，并生成详细的参考文档。通过正确配置Doxyfile和编写标准化的注释，你可以轻松生成跨平台、可维护的项目文档。如果上述方法都检查无误，应该能够成功生成包含内容的Doxygen文档。如果还是遇到问题，可以逐步检查源码注释、配置文件设置、输出目录等环节。
C++注释规范
08-31
对C++代码的注释种类，注释原则，规范细则进行了详细描述
doxygen完整示例
03-07
完整的如何使用Doxygen的例子,包括书写文档块,配置和生成的文档!
VS2010 VS2012 VS2013 VS2015 VS2017 VS2019代码自动注释插件Doxygen
03-13
现在免费分享啦！！！ VS2010、VS2012、VS2013的代码自动注释插件。 安装该插件后，可以在VS的菜单中显示“注释”主菜单，可以给类、函数、成员添加标准的注释，与Doxygen配合使用，可以直接生成项目的注释文档。 源代码： https://github.com/langyastudio/vs-autocomment 说明文档： https://blog.youkuaiyun.com/aoshilang2249/article/details/44239677
Doxygen注释规范
weixin_67003440的博客
12-08 2767
0x20000000/*** @defgroup 定义log的级别* @{* @}*/0123/*** @defgroup 定义log的级别* @{* @}*//*** @param data 参数说明* @param len 参数说明/*** @param data 参数说明* @param len 参数说明/*** @param data 参数说明* @param len 参数说明/*** @param data 参数说明* @param len 参数说明。
[①Doxygen]: 入门，注释语法简介
Eng_ingLi的博客
07-14 1844
Doxygen软件说明书工具入门，使用注释生成说明书，注释语法简介
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值