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

【问题标题】：Microsoft Web API Help page - how to create annotations for parametersMicrosoft Web API 帮助页面 - 如何为参数创建注释
【发布时间】：2014-11-23 17:43:21
【问题描述】：

最近我开始使用新的 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>

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

【问题讨论】：

标签： api web attributes documentation

【解决方案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; }
}

这会给你这样的输出：-

【讨论】：