如何在Swashbuckle文档中添加换行符？

提问于 2024-05-17T10:30:58+08:00

浏览次

10

我正在使用swagger / swashbuckle为Web Api 2中实现的api生成文档 .

唯一识别的xml文档标签是 <summary> ， <remarks> 和 <param> .
这意味着我无法使用 <para> 标记在新行或段落中格式化我的文本，所有内容都在文档的Implementation Notes条目中生成为连续的长段落 .

有没有办法做到这一点？

4 回答

14

另一种实现方法是创建自定义OperationFilter并使用xml文档标记，如下所述：

https://github.com/domaindrivendev/Swashbuckle/issues/258

希望这可以帮助

山姆

回复于 2024-05-17T10:30:58+08:00
2
我发现你可以在评论中添加标签来实现这一目标 .
添加：
```
/// 
```
将导致生成的文档中的换行符 .
回复于 2024-05-17T10:30:58+08:00
0
所有发布的解决方案都不适用于较新版本的Swagger . 如果要在注释行之间分隔换行符，则必须为换行添加 /// . 这使得方法注释变得冗长，但在Swagger文档中它们将更具可读性 .
```
///  <summary>
/// Comment Line 1
///  
/// Comment Line 2
///  
/// Comment Line 3
///  </summary>
```
回复于 2024-05-17T10:30:58+08:00
4
在SwashBuckle.AspNetCore 和 <br /&gt （suggested in github）不起作用 . 在 <remarks> 中，您可以在行尾指定反斜杠 .

例如
```
/// <remarks>
///  before. \
///  after.  
/// </remarks>
```
生成2行
```
before.
after.
```
但是我无法在 <summary> 部分生成多行 .

注意，如果该行有尾随空格（例如 "before. \ " ），则反斜杠将在输出中按字面显示 . 您可以在https://github.com/MNF/Samples/blob/master/SwashbuckleExample/SwashbuckleExample/Controllers/SwashBuckleTest.cs看到我的一些尝试
回复于 2024-05-17T10:30:58+08:00

相关问题