如何在 Swashbuckle 文档中添加换行符？
How to add line break to Swashbuckle documentation?
我正在为使用 swagger/swashbuckle 在 Web Api 2 中实现的 api 生成文档。
唯一可识别的 xml 文档标签是 <summary>、<remarks> 和 <param>。
这意味着我不能使用 <para> 标签在新行或新段落中格式化我的文本，所有内容都在文档的实施说明条目中生成为连续的长段落。
有什么办法吗？
我发现您只需在评论中添加 <br /> 标签即可。
添加：
/// <br />
将导致生成的文档中出现换行符。
另一种实现方法是创建自定义 OperationFilter 并使用 xml 文档标签，如
中所述
https://github.com/domaindrivendev/Swashbuckle/issues/258
希望对您有所帮助
山姆
在 SwashBuckle.AspNetCore 中 <br /> 和 <br />(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
中看到我的一些尝试
None 已发布的解决方案将适用于较新版本的 Swagger。如果您想在注释行之间使用换行符分隔，则必须为换行符添加 /// 。这使得方法注释变得冗长，但它们在 Swagger 文档中将更具可读性。
/// <summary>
/// Comment Line 1
///
/// Comment Line 2
///
/// Comment Line 3
/// </summary>
使用下面的结构，Swashbuckle UI 和 ReDoc UI 都可以工作：
/// <summary>
/// Title
///
/// <para>Content line 1</para>
/// <para>Content line 2</para>
/// <para>Content line 3/</para>
/// </summary>
重要提示：不要忽略每行末尾的空格
如果 none 个答案对您有用，那么在某些情况下部分有用，就像我一样。
您可以使用 <br></br>。不要使用 </br>。它有时会破坏 XML。 Visual studio <br/>
的 XML 格式不正确
使用 Visual Studio 2019 (.net core 3.1)，我可以使用 html 评论。可以使用 <br /> 在一行中完成所有操作。我还尝试了其他 html 标记，例如下划线和粗体。
/// <summary>
/// test
/// </summary>
/// <remarks><u>underline</u> "test line 1" <br /><b>Bold</b> "test line 2" </remarks>
经过长时间的搜索，我发现 *** 用于粗体文本，我知道这不是同一个主题，但我很确定这对这里的人有用！
示例：
***400 - BadRequest When any parameter is out of specification.***
根据 markdown 规范，可以在备注中添加一个新行，方法是添加双 space（两个 spaces）来结束行
我正在为使用 swagger/swashbuckle 在 Web Api 2 中实现的 api 生成文档。
唯一可识别的 xml 文档标签是 <summary>、<remarks> 和 <param>。
这意味着我不能使用 <para> 标签在新行或新段落中格式化我的文本，所有内容都在文档的实施说明条目中生成为连续的长段落。
有什么办法吗？
我发现您只需在评论中添加 <br /> 标签即可。
添加：
/// <br />
将导致生成的文档中出现换行符。
另一种实现方法是创建自定义 OperationFilter 并使用 xml 文档标签，如
中所述https://github.com/domaindrivendev/Swashbuckle/issues/258
希望对您有所帮助
山姆
在 SwashBuckle.AspNetCore 中 <br /> 和 <br />(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
None 已发布的解决方案将适用于较新版本的 Swagger。如果您想在注释行之间使用换行符分隔，则必须为换行符添加 /// 。这使得方法注释变得冗长，但它们在 Swagger 文档中将更具可读性。
/// <summary>
/// Comment Line 1
///
/// Comment Line 2
///
/// Comment Line 3
/// </summary>
使用下面的结构，Swashbuckle UI 和 ReDoc UI 都可以工作：
/// <summary>
/// Title
///
/// <para>Content line 1</para>
/// <para>Content line 2</para>
/// <para>Content line 3/</para>
/// </summary>
重要提示：不要忽略每行末尾的空格
如果 none 个答案对您有用，那么在某些情况下部分有用，就像我一样。
您可以使用 <br></br>。不要使用 </br>。它有时会破坏 XML。 Visual studio <br/>
使用 Visual Studio 2019 (.net core 3.1)，我可以使用 html 评论。可以使用 <br /> 在一行中完成所有操作。我还尝试了其他 html 标记，例如下划线和粗体。
/// <summary>
/// test
/// </summary>
/// <remarks><u>underline</u> "test line 1" <br /><b>Bold</b> "test line 2" </remarks>
经过长时间的搜索，我发现 *** 用于粗体文本，我知道这不是同一个主题，但我很确定这对这里的人有用！
示例：
***400 - BadRequest When any parameter is out of specification.***
根据 markdown 规范，可以在备注中添加一个新行，方法是添加双 space（两个 spaces）来结束行