You need to enable JavaScript to run this app.
优惠活动
大模型
产品
解决方案
定价
更多

单文件多函数能否通过Doxygen分别生成独立文档?

解决Doxygen同一文件多函数文档合并问题

你重复使用@file标签是错误的——一个文件只能有一个@file注释,这也是导致文档合并的核心原因。要实现每个函数生成独立文档,无需拆分文件,只需为每个函数单独编写函数级Doxygen注释即可,不要在函数前添加@file标签。

正确示例代码

/**
 * @file
 * @brief 包含多个关联函数的文件
 * */

/**
 * @brief 函数1的功能描述
 * @param arg 输入参数说明
 * @details 函数1的详细实现说明(可选)
 */
void func1(int arg) {
// do something
}

/**
 * @brief 函数2的功能描述
 * @param arg 输入参数说明
 * @details 函数2的详细实现说明(可选)
 */
void func2(int arg) {
// do something
}

关键说明

  • 整个文件仅保留一个@file注释,放在文件开头用于描述整体用途。
  • 每个函数前单独编写@brief、@param等函数级注释,Doxygen会自动为每个函数生成独立的文档条目,不会合并。
  • 若需要对关联函数进行分组管理,可额外使用@defgroup和@ingroup标签,这不会影响每个函数的独立文档展示。

内容的提问来源于stack exchange,提问作者Bryan Hanson

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.07.02 02:23:10