c# - 如何向 Json.NET 输出添加注释？

Question

有没有一种方法可以自动向 Json.NET 的序列化输出添加注释？

理想情况下，我认为它类似于以下内容:

public class MyClass
{
    [JsonComment("My documentation string")]
    public string MyString { get; set; }
}

或者(如果可以避免注释则更好):

public class MyClass
{
    /// <summary>
    /// My documentation string
    /// </summary>
    public string MyString { get; set; }
}

那会产生:

{
    // My documentation string
    "MyString": "Test"
}

我问的原因是我们使用 Json.NET 序列化配置文件，以后可以手动更改。我想在我的 C# 配置类中包含文档，并在 JSON 中复制该文档，以帮助以后可能需要更改文件的人。

---

正如 RoToRa 在下面指出的那样，JSON 规范在技术上不允许注释(请参阅 http://www.json.org 中的方便语法图)。但是，Json.NET site 上的功能表包括:

Supports reading and writing comments

和 Newtonsoft.Json.JsonTextWriter.WriteComment(string) 存在，它确实输出评论。我对创建评论的简洁方式感兴趣，而不是直接使用 JsonTextWriter。

Answer 1

Json.NET JsonSerializer 在序列化时不会自动输出注释。您需要手动编写 JSON，如果您需要评论，可以使用 JsonTextWriter 或 LINQ to JSON