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

使用MD文件生成Doxygen时Summary与Param不显示的问题求助

问题原因&解决步骤

1. 修正Markdown代码块及注释格式

当前代码块用单引号包裹、注释内容做了HTML实体转义,导致Doxygen无法正确识别C#风格注释,修改后如下:

# API List
## Initialization (class name: ABC)
```csharp
    /// <summary>
    /// XYZ 
    /// </summary>
    /// <param name="enableLog">可补充参数说明文本</param>
    public static void Init(bool enableLog);
- 用三个反引号```包裹代码块(替换原单引号),确保Doxygen识别代码块
- 移除注释中的`&lt;`、`&gt;`、`&quot;`转义字符,直接使用原生`<summary>``<param>`标签和双引号

#### 2. 调整Doxyfile配置适配C#
原配置启用了C语言优化,与C#注释解析规则冲突,需修改以下项:
替换C优化配置为C#优化

OPTIMIZE_OUTPUT_FOR_CSHARP = YES

指定md文件按C#规则解析

EXTENSION_MAPPING = md=csharp

未使用自定义宏时,关闭宏扩展避免干扰注释解析

MACRO_EXPANSION = NO
EXPAND_ONLY_PREDEF = NO

#### 3. 验证核心提取配置
确保以下配置保持开启,保证注释内容被正常提取:

EXTRACT_ALL = YES
EXTRACT_STATIC = YES

修改完成后重新执行doxygen生成文档,Summary和Param的注释内容即可正常显示。

内容的提问来源于stack exchange,提问作者Affectionate Mango
相关产品推荐
方舟 Agent Plan

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

最近更新时间:2026.06.17 18:22:45