可能 XML tags/functions 用于 swagger 文档？

Question

例如，我记得读过，您可以通过编写类似于以下内容的内容在 XML 中创建 table：

||__Column__||                              
||    row   ||

遗憾的是，我不记得出处或它的名字。有没有一个地方记录了所有这些整洁的小东西，如果没有，有人可以照亮它们吗？

我不完全确定以上是 swashbuckle 独有的，还是一般 XML。如果一般来说是关于 XML，请编辑此问题。如果你不能 - 让我知道。

Answer 1

基本 XML 文档如下所示：

/// <summary>
/// Retrieves a specific product by unique id
/// </summary>
/// <remarks>Awesomeness!</remarks>
/// <response code="200">Product created</response>
/// <response code="400">Product has missing/invalid values</response>
/// <response code="500">Oops! Can't create your product right now</response>
[HttpGet("{id}")]
[ProducesResponseType(typeof(Product), 200)]
[ProducesResponseType(typeof(IDictionary<string, string>), 400)]
[ProducesResponseType(500)]
public Product GetById(int id)

值得指出的是，您必须启用它：
https://github.com/domaindrivendev/Swashbuckle.AspNetCore#include-descriptions-from-xml-comments

你显示的 table 看起来像标记，也许你想做的是在文档中添加它...
您可以在 <remarks>、HTML 中包含更多内容，并且标记是有效语法

    /// <summary>
    /// Testing the summary on the ApiExplorerController
    /// </summary>
    ///
    /// <remarks>
    /// Testing the description on the ApiExplorerController
    /// This is a second line
    /// Here is a link to <a href="https://github.com/heldersepu">my GitHub profile</a>
    /// <br/>
    /// Some HTML styling: <b>BOLD</b> <i>italics</i>
    /// <ul>
    /// <li>Item one</li>
    /// <li>Item two</li>
    /// </ul>
    /// <pre>Text in a pre element</pre>
    ///
    /// <h1>Header1</h1>
    /// <h2>Header2</h2>
    /// <h3>Header3</h3>
    /// </remarks>
    public IEnumerable<string> Get()

这是 UI 中的样子：
http://swagger-net-test.azurewebsites.net/swagger/ui/index?filter=ApiExplorer#/ApiExplorer/ApiExplorer_Get

这是一个标记 table

    ///<summary>Post</summary>
    /// <remarks>
    /// Testing Markdown table
    /// | a | b | c | d | e |
    /// |---|---|---|---|---|
    /// | 3 | 0 | 7 | 4 | 1 |
    /// | 4 | 1 | 8 | 5 | 2 |
    /// | 5 | 2 | 9 | 6 | 3 |
    /// </remarks>
    [Route("Post Arrays")]
    public Arrays Post(Arrays arrays)

table在UI上有点拉长了:
http://swagger-net-test.azurewebsites.net/swagger/ui/index?filter=ArrayTest#/ArrayTest/ArrayTest_Post

可能 XML tags/functions 用于 swagger 文档？

Possible XML tags/functions for use in swagger documentations?

c#

xml

xml-documentation

swagger-ui

swashbuckle