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; ?>
】
相关推荐
- 使用类变量定义字符串常量时如何实现类型安全的 Li
- Python对象比较与排序_魔术方法解析【教程】
- Win10闹钟铃声怎么自定义 Win10闹钟自定义
- Linux如何安装JDK11_Linux环境变量配
- Python列表推导式与字典推导式教程_简化代码高
- Python数据挖掘进阶教程_分类回归与聚类案例解
- Windows10如何删除恢复分区_Win10 D
- Python多线程使用规范_线程安全解析【教程】
- Windows 11如何查看系统激活密钥_Wind
- 如何在 Django 中修改用户密码后保持会话不丢
- 如何优化Golang内存分配与GC调度_Golan
- Windows10电脑怎么设置防火墙出站规则_Wi
- 如何使用正则表达式提取以编号开头、后接多个注解的逻
- php485返回数据不完整怎么办_php485数据
- Python 中将 ISO 8601 时间戳转换为
- phpstudy本地环境mysql忘记密码_重置m
- Windows10系统怎么查看显卡驱动_Win10
- Win10怎样安装Word样式库_Win10安装W
- php485在macos下怎么配置_php485
- GML (Geography Markup Lan
- c++怎么处理多线程死锁_c++ lock_gua
- Windows10怎么备份注册表_Windows1
- 如何使用Golang模拟请求超时_Golang c
- Win11怎么更改系统语言为中文_Windows1
- mac怎么退出id_MAC退出iCloud账号与A
- 一文教你快速开通网站LOGO图
- Linux如何申请SSL免费证书_Linux下Ce
- 如何在Golang中使用time处理时间_Gola
- Win11怎么关闭贴靠布局_Win11禁用窗口最大
- Python装饰器复用技巧_通用能力解析【教程】
- php内存溢出怎么排查_php内存限制调试与优化方
- Windows Defender扫描失败怎么办_安
- 如何在Golang中实现服务熔断与限流_Golan
- Win10系统怎么查看端口状态_Windows10
- 如何解决Windows字体显示模糊的问题?(Cle
- 如何在Golang中指定模块版本_使用go.mod
- VSC怎样在VSC中调试PHPAPI_接口调试技巧
- mac怎么查看wifi密码_MAC查看已连接WiF
- Win11怎么设置右键刷新选项_Windows11
- 如何在Golang中编写端到端测试_Golang
- PHP主流架构怎么部署到Docker_容器化流程【
- 如何使用Golang反射创建map对象_动态生成键
- Python装饰器设计思路_功能增强机制说明【指导
- Win10怎样卸载TeamViewer_Win10
- Windows系统文件被保护机制阻止怎么办_权限不
- 如何在Golang中处理JSON字段缺失_Gola
- php订单日志怎么导出excel_php导出订单日
- Win11怎么关闭通知中心_Windows11系统
- MAC怎么在照片中添加水印_MAC自带编辑工具文字
- Python代码测试策略_质量保障解析【教程】

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客服