Параметр параметра Описание в XMLCOMMENTS

Question

Я использую Swashbuckle 5.5.3 и настраиваемую документацию API, используя XMLComments. Я поместил описание свойств модели, которое не редактируется в документации 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; } 
}