मैं जेसन.नेट आउटपुट में टिप्पणियां कैसे जोड़ूं?

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

कारण मैं पूछता हूं कि हम कॉन्फ़िगरेशन को क्रमबद्ध करने के लिए जेसन.NET का उपयोग करते हैं फ़ाइल जिसे बाद में हाथ से बदला जा सकता है। मैं अपने सी # कॉन्फ़िगरेशन कक्षाओं में प्रलेखन शामिल करना चाहता हूं और जेएसओएन में पुन: उत्पन्न करना चाहता हूं ताकि जो भी बाद में फ़ाइल को बदलना पड़े।

अद्यतन: RoToRa नीचे बताते हैं के रूप में, टिप्पणियाँ तकनीकी रूप से JSON कल्पना में अनुमति नहीं है (http://www.json.org पर काम वाक्य रचना चित्र देखें)। हालांकि, Json.NET site पर सुविधाएँ तालिका में शामिल हैं:

पढ़ने और टिप्पणियां लिख

और Newtonsoft.Json.JsonTextWriter.WriteComment(string) जो एक टिप्पणी उत्पादन करता है मौजूद है समर्थन करता है। मुझे सीधे JsonTextWriter का उपयोग करने के बजाय टिप्पणियां बनाने के एक साफ तरीके से रूचि है।

Answer 1

जेसन.NET JsonSerializer क्रमबद्ध होने पर स्वचालित रूप से टिप्पणियां आउटपुट नहीं करता है। यदि आप टिप्पणियां चाहते हैं तो आपको JSONTextWriter या LINQ से JSON का उपयोग करके मैन्युअल रूप से JSON लिखना होगा।

Answer 2

समस्या यह है कि फ़ाइल प्रारूप के रूप में JSON टिप्पणियों का समर्थन नहीं करता है। एक चीज जो आप कर सकते हैं - यदि JSON फ़ाइल पढ़ने वाला एप्लिकेशन इसे अनुमति देता है - इस प्रश्न में सुझाए गए टिप्पणियों के रूप में अतिरिक्त गुणों का उपयोग करना है: Can comments be used in JSON?

Answer 3

जैसा कि @RoToRa पहले से ही कहा गया है, JSON टिप्पणियों की अनुमति नहीं देता है।

यदि आप अभी भी टिप्पणियां चाहते हैं, और आप सही JSON आउटपुट करना चाहते हैं, तो आप डेटा लेआउट को बदलकर वास्तविक JSON डेटा का टिप्पणियां ही बना सकते हैं। उदाहरण के लिए:

{ 
    "MyString": { 
     "doc": "My documentation string", 
     "value": "Test" 
    } 
}