XMLCOMMENTS中的模型参数描述

Question

我使用Swashbuckle 5.5.3使用XMLComments和自定义API文档。我已经在API文档中编写了未编辑的模型属性的描述。

示例代码：

/// <summary>
/// SomeDetails.
/// </summary>
/// <param name="Model">SomeDetails.</param>
/// <param name="Model.UserName">SomeDetails of username.</param>
/// <param name="Model.OwnerId">SomeDetails.</param>

它显示了摘要，我将其放在首位，但未显示模型属性详细信息。

Answer 1

正如SwashBuckle documentation中所述，您必须将参数说明放在属性上，而不是方法上的参数。

在您的情况下，这意味着拥有这样的模型：

public class Model
{
    /// <summary>
    /// user Name (e.g. ...)
    /// </summary>
    public string UserName { get; set; }

    /// <summary>
    /// Id of the owner in context of...
    /// </summary>
    public int OwnerId { get; set; }
}