api - Microsoft Web API 帮助页面 - 如何为参数创建注释

Question

最近我开始使用新的 web api 帮助页面功能，这是最近添加到 web api 项目模板的。我注意到一些“附加信息”列始终为“无”。



看了一些标记后，我发现这个信息应该来自属性

 <td class="parameter-annotations">
                    @if (parameter.Annotations.Count > 0)
                    {
                        foreach (var annotation in parameter.Annotations)
                        {
                            <p>@annotation.Documentation</p>
                        }
                    }
                    else
                    {
                        <p>None.</p>
                    }
                </td>

但是我应该使用什么样的属性来填充附加信息？
谢谢

Answer 1

见 this site有关如何添加附加信息的示例。

它基本上是在注释你的模型，所以在你的情况下它会是这样的:-

public class Product
{
    /// <summary>
    ///  The id of the product
    /// </summary>
    [Required]
    public int Id { get; set; }

    /// <summary>
    /// The name of the product
    /// </summary>
    [MaxLength(50)]
    public string Name { get; set; }
}

这会给你这样的输出:-