数据注释基础

数据注释是一种向类或类成员添加更多上下文信息的方法。注释主要有三类:

  • 验证属性:为数据添加验证标准
  • 显示属性:指定数据应如何显示给用户
  • 建模属性:添加有关使用情况的信息以及与其他类的关系

用法

这是一个使用两个 ValidationAttribute 和一个 DisplayAttribute 的例子:

class Kid
{
    [Range(0, 18)] // The age cannot be over 18 and cannot be negative
    public int Age { get; set; }
    [StringLength(MaximumLength = 50, MinimumLength = 3)] // The name cannot be under 3 chars or more than 50 chars
    public string Name { get; set; }
    [DataType(DataType.Date)] // The birthday will be displayed as a date only (without the time)
    public DateTime Birthday { get; set; }
}

数据注释主要用于 ASP.NET 等框架。例如,在 ASP.NET MVC 中,当通过控制器方法接收模型时,可以使用 ModelState.IsValid() 来判断所接收的模型是否尊重其所有的 ValidationAttributeDisplayAttribute 也用于 ASP.NET MVC,以确定如何在网页上显示值。