XMLCOMMENTS中的模型参数描述

我正在使用Swashbuckle 5.5.3和使用XMLComments定制的API文档。我已经提供了未在API文档中编辑过的模型属性的描述。XMLCOMMENTS中的模型参数描述

示例代码：

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

它显示了总结，我放到了首位，但不显示模型属性的细节。

来源

2016-11-24 Uzair Xlade

你有什么行动PARAMS？在截图中，我看到两个参数：userName和ownerId，而我没有看到任何你描述的“Model”对象。 –

MethodName（[FromUri（Name =“”）] ModelName model）这就是为什么你看不到模型。 –

如果您使用模型对象作为输入，那么描述将取自ModelName类的属性（如UserName，OwnerId等）中提供的文档 –

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

来源

2016-11-25 07:55:00 bsoulier

XMLCOMMENTS中的模型参数描述

回答

相关问题