c++如何利用doxygen生成开发文档_c++ 代码注释规范与HTML文档导出【案例】
技术百科
尼克
发布时间:2026-01-01
浏览: 次 Doxygen仅解析以///或/开头的文档块注释,普通//或/ /注释被忽略;需符合其标记规范才能生成HTML文档。
Doxygen 能直接从 C++ 源码注释生成 HTML 文档,但前提是注释格式必须被它识别——不是所有 // 或 /* */ 都算“文档注释”,只有以特定标记开头(如 ///、/**)且结构合规的注释才会被提取。
哪些注释会被 Doxygen 解析
Doxygen 默认只处理“文档块”(documented blocks),普通代码注释会被忽略。关键看开头标记和上下文:
-
///或///:用于单行函数/变量声明上方,或跟在声明后(int x; ///) -
/** ... */或/*! ... */:多行块,必须紧贴声明前(中间不能有空行) -
//!和//! 也支持,但不如///常用 - 类/函数/枚举前的注释块必须与声明之间**无空行**,否则 Doxygen 视为孤立注释,不绑定
关键配置项:Doxyfile 必设参数
运行 doxygen -g 生成默认配置后,至少要改这几项,否则 HTML 输出可能为空或乱码:
-
PROJECT_NAME = "MyLib":项目名,影响首页标题 -
INPUT = ./src ./include:指定含源码和头文件的目录(支持通配符如./src/*.h) -
RECURSIVE = YES:是否递归扫描子目录 -
EXTRACT_ALL = YES:强制提取所有符号(即使没写注释),方便初期梳理接口 -
GENERATE_HTML = YES(默认已开),同时建议开GENERATE_TREEVIEW = YES方便导航 -
OUTPUT_DIRECTORY = ./docs:输出路径,确保该目录可写
常见错误:生成的 HTML 里看不到函数或类
最常因三类问题导致内容缺失:
- 注释写在声明**之后**且中间有空行,例如:
class Widget { }; /// @brief A widget class Widget { };→ Doxygen 不关联 - 用了
//而非///,比如:// @param x horizontal position void setPos(int x);
→ 不解析 -
INPUT路径写错,或文件扩展名未包含在FILE_PATTERNS中(默认含*.h *.hpp *.cpp *.cc,但若用.tcc就要手动加) - 函数定义在 .cpp 里,但
INPUT只指定了./include,而头文件里没写文档注释
一个最小可用示例
假设有 math_utils.h:
/// @file math_utils.h /// @brief Basic math utilities for vector operations.ifndef MATH_UTILS_H
define MATH_UTILS_H
/// @brief Compute squared distance between two 2D points. /// @param x1 X coor
dinate of first point /// @param y1 Y coordinate of first point /// @param x2 X coordinate of second point /// @param y2 Y coordinate of second point /// @return Squared Euclidean distance (no sqrt) double sqDistance(double x1, double y1, double x2, double y2);
endif // MATH_UTILS_H
配好 Doxyfile 后执行 doxygen,就会在 ./docs/html/index.html 里看到带参数说明的函数页。注意:@file 和 @brief 这类命令必须写在注释块内,且大小写敏感(@param 不是 @PARAM)。
真正卡住人的往往不是语法,而是注释与声明的物理位置关系、路径配置的拼写错误、以及默认 EXTRACT_ALL = NO 导致未注释的类直接消失——先开 EXTRACT_ALL 看全貌,再逐个补文档,比反复猜哪里漏了更省时间。
# 这类
# 会在
# 用了
# 才会
# 文档
# 而非
# 写在
# 递归
# c++
# html
# 头文件
# 跟在
相关栏目:
<?muma
$count = M('archives')->where(['typeid'=>$field['id']])->count();
?>
【
AI推广<?muma echo $count; ?>
】
<?muma
$count = M('archives')->where(['typeid'=>$field['id']])->count();
?>
【
SEO优化<?muma echo $count; ?>
】
<?muma
$count = M('archives')->where(['typeid'=>$field['id']])->count();
?>
【
技术百科<?muma echo $count; ?>
】
<?muma
$count = M('archives')->where(['typeid'=>$field['id']])->count();
?>
【
谷歌推广<?muma echo $count; ?>
】
<?muma
$count = M('archives')->where(['typeid'=>$field['id']])->count();
?>
【
百度推广<?muma echo $count; ?>
】
<?muma
$count = M('archives')->where(['typeid'=>$field['id']])->count();
?>
【
网络营销<?muma echo $count; ?>
】
<?muma
$count = M('archives')->where(['typeid'=>$field['id']])->count();
?>
【
案例网站<?muma echo $count; ?>
】
<?muma
$count = M('archives')->where(['typeid'=>$field['id']])->count();
?>
【
精选文章<?muma echo $count; ?>
】
相关推荐
- WindowsUSB驱动安装异常怎么办_USB驱动
- Win10怎么卸载迅雷_Win10彻底卸载迅雷方法
- mac怎么安装pip_MAC Python pip
- php条件判断怎么写_ifelse和switchc
- Python抽象类与接口设计_规范说明【指导】
- PyTorch DDP 多进程训练在 Kaggle
- 一文详解网站被黑客入侵挂马解决办法
- Win11怎么关闭透明效果_Windows11个性
- 用lighttpd能运行php吗_lighttpd
- Win11讲述人怎么关闭_Win11误触开启语音朗
- Win11相机打不开提示错误怎么修_相机权限开启与
- Python与Docker容器化部署实战_镜像构建
- c++输入输出流 c++ cin与cout格式化输
- c# F# 的 MailboxProcessor
- Win11无法安装软件怎么办_Win11解除应用安
- c++的mutex和lock_guard如何使用
- Windows服务持续崩溃怎样修复_系统服务保护机
- Windows蓝屏错误0x00000023怎么修复
- 如何使用Golang写入二进制文件_Golang
- Win11无法拖拽文件到任务栏怎么办_Win11开
- 如何在Golang中捕获结构体方法错误_Golan
- 如何使用Golang管理跨项目依赖_Golang多
- Windows7如何安装系统镜像_Windows7
- PHP 中如何在函数内持久修改引用变量所指向的目标
- Windows10无法连接到Internet_Wi
- 如何使用Golang搭建本地API测试环境_快速验
- Win11怎么设置默认图片查看器_Windows1
- mac怎么安装字体_MAC添加第三方字体与字体册管
- 如何优化Golang程序CPU性能_Golang
- 如何使用Golang理解结构体指针方法接收者_Go
- Win11怎么忘记WiFi网络_Win11删除已保
- php怎么下载安装后设置默认字符集_utf8配置步
- Win11怎么修复系统文件_使用sfc命令修复Wi
- 电脑的“网络和共享中心”去哪了_Windows 1
- Win10如何备份注册表_Win10注册表备份步骤
- Mac如何将HEIC图片格式转为JPG_Mac批量
- Win11资源管理器卡顿怎么办 Win11文件资源
- c++如何判断文件是否存在_c++ filesys
- Win11怎样激活系统密钥_Win11系统密钥激活
- 如何在Windows上设置闹钟和计时器_系统自带的
- php485能和物联网模块通信吗_php485对接
- Windows10系统怎么查看设备管理器_Win1
- 如何在Golang中定义接口_抽象方法和多态实现
- Win11怎么关闭任务栏小图标_Windows11
- 如何使用Golang模拟请求超时_Golang c
- Mac怎么查看活动监视器_理解Mac进程和资源占用
- 如何用::实现单例模式_php静态方法与作用域操作
- Python装饰器复用技巧_通用能力解析【教程】
- Win11怎么开启移动热点_Windows11共享
- Win10怎样卸载iTunes_Win10卸载iT

dinate of first point
/// @param y1 Y coordinate of first point
/// @param x2 X coordinate of second point
/// @param y2 Y coordinate of second point
/// @return Squared Euclidean distance (no sqrt)
double sqDistance(double x1, double y1, double x2, double y2);
QQ客服