Trang Trợ giúp API Web của Microsoft - cách tạo chú thích cho tham số

Question

Gần đây tôi đã bắt đầu chơi với chức năng trang trợ giúp api mới trên web, gần đây đã được thêm vào mẫu dự án api web. Và tôi có thông báo rằng một số cột "Thông tin bổ sung" luôn là 'không có'.

Sau một nhìn vào đánh dấu tôi thấy rằng thông tin này sẽ đến từ các thuộc tính

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

Nhưng những loại thuộc tính tôi nên sử dụng, để cư biết thêm chi tiết? Cảm ơn

Answer 1

Xem this site để biết ví dụ về cách thêm thông tin bổ sung.

Đó là cơ bản chú thích mô hình của bạn, vì vậy trong trường hợp của bạn nó sẽ là một cái gì đó như: -

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

Trong đó sẽ cung cấp cho bạn một kết quả như thế này: -