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

添加@fn标签后Doxygen文档内容被忽略,移除后正常,求排查原因

问题原因及解决办法

你的问题出在@fn标签里的函数签名写错了——你把指针符号*放在了函数名后面,而不是返回类型IOChunk_t的后面。Doxygen对@fn的函数签名解析非常严格,格式错误会导致它无法识别这个注释块,进而忽略相关文档内容。

修正后的注释示例

/**
 * @fn IOChunk_t* ioAllocateLargestChunk(void)
 * @brief Allocates the largest available chunk.
 *
 * @return pointer to allocated @ref IOChunk_t or @ref NULL if allocation failed
 */
IOChunk_t* ioAllocateLargestChunk(void);    // Return the biggest normal chunk we can get (starting at 8k)

关键说明

  • @fn标签要求函数签名和实际代码里的函数声明完全一致,包括返回类型、指针位置、参数列表这些细节。
  • 你原来的写法IOChunk_t ioAllocateLargestChunk*(void)不符合C语言的函数声明规范,Doxygen解析时会判定为无效签名,导致整个注释块失效。

内容的提问来源于stack exchange,提问作者0___________

相关产品推荐
方舟 Agent Plan

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

最近更新时间:2026.07.20 12:27:05