資料註釋基礎
資料註釋是一種向類或類成員新增更多上下文資訊的方法。註釋主要有三類:
- 驗證屬性:為資料新增驗證標準
- 顯示屬性:指定資料應如何顯示給使用者
- 建模屬性:新增有關使用情況的資訊以及與其他類的關係
用法
這是一個使用兩個 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()
來判斷所接收的模型是否尊重其所有的 ValidationAttribute
。DisplayAttribute
也用於 ASP.NET MVC
,以確定如何在網頁上顯示值。