在使用json.net生成JSON模式時向屬性添加描述

Question

是否可以向屬性添加描述屬性？

我使用json.net生成模式：

var shema = new Newtonsoft.Json.Schema.JsonSchemaGenerator(); 
var sh = shema.Generate(typeof(APIDocumentation.AlertDTO), false).ToString(); 

而且我想補充一些簡單的文檔，供用戶瞭解每個字段的含義。 現在，我可以使用[JsonObject（Description =「my description」）]將描述屬性添加到類中，但它不能用於類中的屬性。是否有一個方法可行這樣做：

[JsonObject(Description = "My description")] 
public class AlertDTO 
{ 
    [SomeAttribute(Description="Property description")] 
    public string Type { get; set; } 

} 

或者，也許有一種方式，採取VS風格的註釋，並將它們添加到JSON模式的描述？

Answer 1

您可以使用System.ComponentModel命名空間中的Description屬性。

我花了一段尋找，但沒有在文檔中的例子：https://www.newtonsoft.com/jsonschema/help/html/GenerateWithDescriptions.htm