Swashbuckle.AspNetCore 中 XML 文档注释的格式问题解析

问题背景

在使用 Swashbuckle.AspNetCore 生成 API 文档时，开发者发现当在 XML 文档注释的 <remarks> 标签中使用 <details> 和 <code> 组合时，生成的文档显示会出现异常格式问题。具体表现为代码块前出现大量空白，影响文档的可读性和美观性。

问题复现

当开发者使用如下格式的 XML 文档注释时：

/// <summary>My work api</summary>
/// <remarks>
/// <details>
/// <summary>Details Title</summary>
/// <code>
/// {
///  "Prop1":1,
///  "Prop2":[]
/// }
/// </code>
/// </details>
/// </remarks>

生成的 Swagger UI 文档会显示异常，代码块前出现大量不必要的空白。通过分析生成的 OpenAPI JSON 描述，可以看到 <code> 标签被转换为 Markdown 的代码块语法（```），但格式处理存在问题。

技术分析

1. XML 文档注释规范：C# 的 XML 文档注释标准并未正式支持 <details> 标签，官方文档中只推荐使用标准标签如 <summary>, <remarks>, <code> 等。

2. Swashbuckle 处理机制：Swashbuckle 在转换 XML 注释时会尝试将 <code> 标签内容转换为 Markdown 代码块格式，但对于非标准标签如 <details> 的处理不够完善。

3. HTML 与 Markdown 转换：Swagger UI 最终渲染的是 HTML，而 Swashbuckle 在中间处理过程中涉及 XML 到 Markdown 再到 HTML 的多重转换，这可能导致某些特殊格式的丢失或变形。

解决方案

经过测试，发现以下两种解决方案：

临时解决方案

在 <details> 前添加文本内容，并在 <code> 标签前后添加 <br/> 换行标签：

/// <summary>My work api</summary>
/// <remarks>
/// You need put some text before "details" tag can reomve the long space string in output
/// <details>
/// <summary>Details Title</summary><br/>
/// <code>
/// {
///  "Prop1":1,
///  "Prop2":[]
/// }
/// </code><br/>
/// </details>
/// </remarks>

长期建议

1. 避免使用非标准标签：尽量只使用 C# 官方文档支持的 XML 注释标签。

2. 对于代码示例：可以单独使用 <code> 标签，或考虑将示例代码放在外部文件中引用。

3. 对于需要折叠的内容：考虑使用 Swagger 的扩展特性或等待 Swashbuckle 对 <details> 标签的正式支持。

最佳实践

1. 代码示例格式化：确保 <code> 标签内的内容正确缩进，避免额外的空白。

2. 标签组合测试：在使用非标准标签组合时，应进行充分测试。

3. 关注更新：关注 Swashbuckle.AspNetCore 的更新，该问题已在最新版本中得到部分修复。

总结

XML 文档注释是 .NET API 开发中的重要组成部分，但在使用非标准标签时需要特别注意兼容性问题。开发者应当优先使用标准标签，对于特殊需求可以寻找替代方案或等待框架的官方支持。Swashbuckle.AspNetCore 团队正在不断改进对 XML 注释的处理，未来版本可能会提供更完善的解决方案。