모델 매개 변수 설명 (XMLCOMMENTS)

Question

을 사용하여 Swashbuckle 5.5.3 및 사용자 지정된 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에 명시된 바와 같이 매개 변수 설명을 속성에 직접 입력해야합니다. 매개 변수 설명은 메소드의 매개 변수가 아닙니다. 액션의 PARAMS은 무엇

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; } 
}