ความคิดเห็นสามารถใช้ใน JSON ได้หรือไม่

ฉันสามารถใช้ความคิดเห็นภายในไฟล์ JSON ได้หรือไม่ ถ้าเป็นเช่นนั้นได้อย่างไร

เลขที่

JSON ควรเป็นข้อมูลทั้งหมดและหากคุณใส่ความคิดเห็นไว้ข้อมูลนั้นก็จะเป็นข้อมูลเช่นกัน

คุณสามารถมีองค์ประกอบข้อมูลที่กำหนดเรียกว่า"_comment"(หรือบางอย่าง) ซึ่งจะถูกละเว้นโดยแอปที่ใช้ข้อมูล JSON

คุณอาจจะมีความคิดเห็นที่ดีขึ้นในกระบวนการที่สร้าง / รับ JSON เนื่องจากพวกเขาควรจะรู้ว่าข้อมูล JSON จะเป็นอะไรล่วงหน้าหรืออย่างน้อยก็โครงสร้างของมัน

แต่ถ้าคุณตัดสินใจที่จะ:

{
   "_comment": "comment text goes here...",
   "glossary": {
      "title": "example glossary",
      "GlossDiv": {
         "title": "S",
         "GlossList": {
            "GlossEntry": {
               "ID": "SGML",
               "SortAs": "SGML",
               "GlossTerm": "Standard Generalized Markup Language",
               "Acronym": "SGML",
               "Abbrev": "ISO 8879:1986",
               "GlossDef": {
                  "para": "A meta-markup language, used to create markup languages such as DocBook.",
                  "GlossSeeAlso": ["GML", "XML"]
               },
               "GlossSee": "markup"
            }
         }
      }
   }
}

ไม่ความคิดเห็นของฟอร์ม//…หรือ/*…*/ไม่ได้รับอนุญาตใน JSON คำตอบนี้ขึ้นอยู่กับ:

• http://www.json.org
• RFC 4627 : application/jsonประเภทสื่อสำหรับสัญลักษณ์วัตถุ JavaScript (JSON)
• RFC 8259รูปแบบการแลกเปลี่ยนข้อมูลวัตถุ JavaScript (JSON) รูปแบบการแลกเปลี่ยนข้อมูล (supercedes RFCs 4627, 7158, 7159)

รวมความคิดเห็นหากคุณเลือก ถอดออกด้วย minifier ก่อนที่จะแยกหรือส่ง

ฉันเพิ่งเปิดตัวJSON.minify ()ซึ่งตัดความคิดเห็นและช่องว่างออกจากบล็อกของ JSON และทำให้ JSON นั้นถูกต้องซึ่งสามารถแยกวิเคราะห์ได้ ดังนั้นคุณอาจใช้มันเช่น:

JSON.parse(JSON.minify(my_str));

เมื่อผมปล่อยให้มันผมได้ฟันเฟืองใหญ่ของคนที่ไม่เห็นด้วยกับความคิดแม้กระทั่งของมันดังนั้นฉันตัดสินใจว่าฉันต้องการเขียนบล็อกโพสต์ที่ครอบคลุมเกี่ยวกับเหตุผลที่ความคิดเห็นให้ความรู้สึกใน JSON มันรวมความคิดเห็นที่น่าทึ่งนี้จากผู้สร้าง JSON:

สมมติว่าคุณกำลังใช้ JSON เพื่อเก็บไฟล์การกำหนดค่าซึ่งคุณต้องการใส่คำอธิบายประกอบ ไปข้างหน้าและใส่ความคิดเห็นทั้งหมดที่คุณชอบ จากนั้นไปป์ผ่าน JSMin ก่อนที่จะส่งไปยังตัวแยกวิเคราะห์ JSON ของคุณ - Douglas Crockford, 2012

หวังว่าจะเป็นประโยชน์กับผู้ที่ไม่เห็นด้วยกับเหตุผลที่JSON.minify ()อาจมีประโยชน์

ความคิดเห็นถูกลบออกจาก JSON โดยการออกแบบ

ฉันลบความคิดเห็นจาก JSON เพราะฉันเห็นคนกำลังใช้พวกเขาเพื่อจัดระเบียบคำสั่งซึ่งเป็นวิธีที่จะทำลายการทำงานร่วมกัน ฉันรู้ว่าการขาดความคิดเห็นทำให้บางคนเศร้า แต่ก็ไม่ควร

สมมติว่าคุณกำลังใช้ JSON เพื่อเก็บไฟล์การกำหนดค่าซึ่งคุณต้องการใส่คำอธิบายประกอบ ไปข้างหน้าและใส่ความคิดเห็นทั้งหมดที่คุณชอบ จากนั้นไปป์ผ่าน JSMin ก่อนที่จะส่งไปยังตัวแยกวิเคราะห์ JSON ของคุณ

ที่มา: คำแถลงสาธารณะของ Douglas Crockford บน G +

การปฏิเสธความรับผิด: การรับประกันของคุณเป็นโมฆะ

ดังที่ได้กล่าวมาแล้วการแฮกนี้ใช้ประโยชน์จากการนำข้อมูลจำเพาะไปใช้ ตัวแยกวิเคราะห์ JSON บางส่วนเท่านั้นที่จะเข้าใจ JSON ประเภทนี้ได้ ตัวแยกวิเคราะห์สตรีมมิ่งโดยเฉพาะจะทำให้หายใจไม่ออก

มันเป็นความอยากรู้ที่น่าสนใจ แต่คุณควรมันไม่ใช้มันเพื่ออะไรเลย ด้านล่างนี้เป็นคำตอบเดิม

ฉันพบแฮ็คเล็กน้อยที่ช่วยให้คุณสามารถแสดงความคิดเห็นในไฟล์ JSON ที่จะไม่ส่งผลกระทบต่อการแยกวิเคราะห์หรือแก้ไขข้อมูลที่แสดงในทางใดทางหนึ่ง

ปรากฏว่าเมื่อประกาศวัตถุตามตัวอักษรคุณสามารถระบุสองค่าด้วยคีย์เดียวกันและสุดท้ายจะมีความสำคัญ เชื่อหรือไม่ปรากฎว่าตัวแยกวิเคราะห์ JSON ทำงานในลักษณะเดียวกัน ดังนั้นเราสามารถใช้สิ่งนี้เพื่อสร้างความคิดเห็นในซอร์ส JSON ที่จะไม่ปรากฏในการแสดงวัตถุแยกวิเคราะห์

({a: 1, a: 2});
// => Object {a: 2}
Object.keys(JSON.parse('{"a": 1, "a": 2}')).length; 
// => 1

หากเราใช้เทคนิคนี้ไฟล์ JSON ที่แสดงความคิดเห็นของคุณอาจมีลักษณะเช่นนี้:

{
  "api_host" : "The hostname of your API server. You may also specify the port.",
  "api_host" : "hodorhodor.com",

  "retry_interval" : "The interval in seconds between retrying failed API calls",
  "retry_interval" : 10,

  "auth_token" : "The authentication token. It is available in your developer dashboard under 'Settings'",
  "auth_token" : "5ad0eb93697215bc0d48a7b69aa6fb8b",

  "favorite_numbers": "An array containing my all-time favorite numbers",
  "favorite_numbers": [19, 13, 53]
}

รหัสข้างต้นเป็นJSON ที่ถูกต้อง หากคุณแยกวิเคราะห์คุณจะได้รับวัตถุเช่นนี้:

{
    "api_host": "hodorhodor.com",
    "retry_interval": 10,
    "auth_token": "5ad0eb93697215bc0d48a7b69aa6fb8b",
    "favorite_numbers": [19,13,53]
}

ซึ่งหมายความว่าไม่มีร่องรอยของความคิดเห็นและพวกเขาจะไม่มีผลข้างเคียงที่แปลก

แฮ็คมีความสุข!

JSON ไม่สนับสนุนความคิดเห็น มันก็ไม่เคยตั้งใจที่จะใช้สำหรับไฟล์การกำหนดค่าที่ความคิดเห็นจะต้อง

Hjson เป็นรูปแบบไฟล์กำหนดค่าสำหรับมนุษย์ ไวยากรณ์ที่ผ่อนคลาย, ข้อผิดพลาดน้อยลง, ความคิดเห็นเพิ่มเติม

ดูhjson.orgสำหรับ JavaScript, Java, Python, PHP, Rust, Go, Ruby และ C #

พิจารณาใช้ YAML มันเกือบจะเป็นชุดของ JSON (เกือบทุก JSON ที่ถูกต้องคือ YAML ที่ถูกต้อง) และอนุญาตให้แสดงความคิดเห็นได้

คุณทำไม่ได้ อย่างน้อยนั่นคือประสบการณ์ของผมจากอย่างรวดเร็วในjson.org

JSON มีรูปแบบการแสดงผลของมันในหน้านั้น ไม่มีหมายเหตุเกี่ยวกับความคิดเห็น

ความคิดเห็นไม่ใช่มาตรฐานอย่างเป็นทางการแม้ว่า parsers บางคนสนับสนุน C ++ - ความคิดเห็นสไตล์ หนึ่งที่ผมใช้เป็นJsonCpp ในตัวอย่างมีสิ่งนี้:

// Configuration options
{
    // Default encoding for text
    "encoding" : "UTF-8",

    // Plug-ins loaded at start-up
    "plug-ins" : [
        "python",
        "c++",
        "ruby"
        ],

    // Tab indent size
    "indent" : { "length" : 3, "use_space": true }
}

jsonlintไม่ได้ตรวจสอบสิ่งนี้ ดังนั้นความคิดเห็นเป็นส่วนขยายที่แยกวิเคราะห์เฉพาะและไม่ได้มาตรฐาน

parser ก็คือJSON5

ทางเลือกในการ JSON TOML

ทางเลือกต่อไปคือjsonc

คุณควรเขียนJSON schemaแทน JSON schema ปัจจุบันเป็นข้อกำหนดทางอินเทอร์เน็ตฉบับร่าง นอกจากเอกสารแล้วสกีมายังสามารถใช้สำหรับตรวจสอบข้อมูล JSON ของคุณ

ตัวอย่าง:

{
    "description":"A person",
    "type":"object",
    "properties":
        {
            "name":
                {
                    "type":"string"
                },
            "age":
                {
                    "type":"integer",
                    "maximum":125
                }
        }
}

คุณสามารถให้เอกสารโดยใช้แอตทริบิวต์description schema

หากคุณใช้แจ็คสันเป็นเครื่องมือแยกวิเคราะห์ JSON ของคุณนี่คือวิธีที่คุณเปิดใช้งานเพื่อให้ความคิดเห็น:

ObjectMapper mapper = new ObjectMapper().configure(Feature.ALLOW_COMMENTS, true);

จากนั้นคุณสามารถมีความคิดเห็นเช่นนี้:

{
  key: "value" // Comment
}

และคุณยังสามารถมีความคิดเห็นที่เริ่มต้นด้วย#การตั้งค่า:

mapper.configure(Feature.ALLOW_YAML_COMMENTS, true);

แต่โดยทั่วไป (ตามคำตอบก่อนหน้านี้) สเปคไม่อนุญาตให้แสดงความคิดเห็น

นี่คือสิ่งที่ฉันพบในเอกสาร Google Firebaseที่อนุญาตให้คุณใส่ความคิดเห็นใน JSON:

{
  "//": "Some browsers will use this to enable push notifications.",
  "//": "It is the same for all projects, this is not your project's sender ID",
  "gcm_sender_id": "1234567890"
}

NO JSON ใช้เพื่อสนับสนุนความคิดเห็น แต่ถูกใช้ในทางที่ผิดและลบออกจากมาตรฐาน

จากผู้สร้าง JSON:

ฉันลบความคิดเห็นจาก JSON เพราะฉันเห็นคนกำลังใช้พวกเขาเพื่อจัดระเบียบคำสั่งซึ่งเป็นวิธีที่จะทำลายการทำงานร่วมกัน ฉันรู้ว่าการขาดความคิดเห็นทำให้บางคนเศร้า แต่ก็ไม่ควร - Douglas Crockford, 2012

เว็บไซต์อย่างเป็นทางการ JSON ที่JSON.org JSON ถูกกำหนดให้เป็นมาตรฐานโดย ECMA International มีกระบวนการยื่นคำร้องเพื่อให้มีการแก้ไขมาตรฐานอยู่เสมอ ไม่น่าเป็นไปได้ที่จะมีการเพิ่มคำอธิบายประกอบในมาตรฐาน JSON ด้วยเหตุผลหลายประการ

JSON โดยการออกแบบเป็นทางเลือกที่ย้อนกลับวิศวกรรม (มนุษย์แยกวิเคราะห์) ได้อย่างง่ายดายเพื่อ XML มันง่ายแม้กระทั่งในจุดที่ว่าคำอธิบายประกอบนั้นไม่จำเป็น มันไม่ได้เป็นภาษามาร์กอัป เป้าหมายคือความมั่นคงและทำงานร่วมกัน

ทุกคนที่เข้าใจความสัมพันธ์ "มี - a" ของการวางแนววัตถุสามารถเข้าใจโครงสร้าง JSON ใด ๆ - นั่นคือทั้งหมด มันเป็นเพียงกราฟกำกับ (DAG) ที่มีแท็กโหนด (คู่คีย์ / ค่า) ซึ่งเป็นโครงสร้างข้อมูลสากลที่อยู่ใกล้

หมายเหตุประกอบที่จำเป็นเท่านั้นนี้อาจเป็น "// นี่คือแท็ก DAG" ชื่อคีย์สามารถเป็นข้อมูลได้ตามต้องการอนุญาตให้ใช้ arity semantic โดยพลการ

แพลตฟอร์มใด ๆ สามารถแยก JSON ด้วยโค้ดเพียงไม่กี่บรรทัด XML ต้องการไลบรารี OO ที่ซับซ้อนซึ่งไม่สามารถใช้งานได้ในหลายแพลตฟอร์ม

คำอธิบายประกอบจะทำให้ JSON ทำงานร่วมกันได้น้อยลง ไม่มีอะไรเพิ่มอีกนอกจากสิ่งที่คุณต้องการจริงๆคือภาษามาร์กอัป (XML) และไม่สนใจว่าข้อมูลที่เก็บไว้ของคุณจะถูกแยกวิเคราะห์อย่างง่ายดาย

แต่ในฐานะผู้สร้าง JSON ก็สังเกตเห็นว่ามีการสนับสนุนไปป์ไลน์ JS สำหรับความคิดเห็น:

ไปข้างหน้าและใส่ความคิดเห็นทั้งหมดที่คุณชอบ จากนั้นไปป์ผ่าน JSMin ก่อนที่จะส่งไปยังตัวแยกวิเคราะห์ JSON ของคุณ - Douglas Crockford, 2012

หากไฟล์ข้อความของคุณซึ่งเป็นสตริง JSON กำลังถูกอ่านโดยโปรแกรมบางโปรแกรมมันจะยากเพียงใดในการแยกความคิดเห็นสไตล์ C หรือ C ++ ก่อนที่จะใช้

คำตอบ:มันจะเป็นหนึ่งซับ หากคุณทำเช่นนั้นไฟล์ JSON สามารถใช้เป็นไฟล์กำหนดค่าได้

หากคุณใช้ไลบรารี Newtonsoft.Json กับ ASP.NET เพื่ออ่าน / deserialize คุณสามารถใช้ข้อคิดเห็นในเนื้อหา JSON:

// "ชื่อ": "สตริง"

// "id": int

หรือ

/* มันคือ

ตัวอย่างความคิดเห็น * /

PS:ความคิดเห็นบรรทัดเดียวได้รับการสนับสนุนเฉพาะกับ Newtonsoft Json รุ่น 6+

หมายเหตุเพิ่มเติมสำหรับผู้ที่ไม่สามารถคิดนอกกรอบ:ฉันใช้รูปแบบ JSON สำหรับการตั้งค่าพื้นฐานในแอปพลิเคชันเว็บ ASP.NET ที่ฉันทำ ฉันอ่านไฟล์แปลงเป็นวัตถุการตั้งค่าด้วยไลบรารี Newtonsoft และใช้เมื่อจำเป็น

ฉันชอบเขียนความคิดเห็นเกี่ยวกับการตั้งค่าส่วนบุคคลในไฟล์ JSON และฉันไม่สนใจเกี่ยวกับความสมบูรณ์ของรูปแบบ JSON ตราบใดที่ไลบรารีที่ฉันใช้นั้นใช้ได้ด้วย

ฉันคิดว่านี่เป็นวิธี 'ใช้งาน / เข้าใจง่ายกว่า' สร้างไฟล์ 'settings.README' แยกต่างหากและอธิบายการตั้งค่าในนั้น

หากคุณมีปัญหากับการใช้งานประเภทนี้ ขออภัยมารนั้นไม่อยู่ในไฟ ผู้คนจะพบกับประเพณีอื่น ๆ สำหรับรูปแบบ JSON และไม่มีอะไรที่คุณสามารถทำได้

แนวคิดเบื้องหลัง JSON คือการให้การแลกเปลี่ยนข้อมูลระหว่างแอปพลิเคชันอย่างง่าย โดยทั่วไปจะใช้เว็บและภาษาคือ JavaScript

ไม่อนุญาตให้มีการแสดงความคิดเห็นเช่นนี้อย่างไรก็ตามการส่งความคิดเห็นเป็นหนึ่งในคู่ชื่อ / ค่าในข้อมูลจะทำงานได้อย่างแน่นอนแม้ว่าข้อมูลนั้นจะต้องถูกละเว้นหรือจัดการโดยรหัสการแยกวิเคราะห์

ทั้งหมดที่กล่าวมานั้นไม่ใช่ความตั้งใจที่ไฟล์ JSON ควรมีความคิดเห็นตามความหมายดั้งเดิม มันควรเป็นข้อมูล

ดูรายละเอียดเพิ่มเติมที่เว็บไซต์ JSON

ฉันเพิ่งพบกับไฟล์กำหนดค่า ฉันไม่ต้องการใช้ XML (verbose, กราฟิก, น่าเกลียด, ยากที่จะอ่าน) หรือรูปแบบ "ini" (ไม่มีลำดับชั้น, ไม่มีมาตรฐานจริง ฯลฯ ) หรือรูปแบบ "คุณสมบัติ" ของ Java (เช่น. ini)

JSON สามารถทำทุกอย่างที่ทำได้ แต่เป็นวิธีที่ละเอียดน้อยกว่าและอ่านได้ง่ายกว่ามนุษย์ - และ parsers นั้นง่ายและแพร่หลายในหลายภาษา มันเป็นต้นไม้ของข้อมูล แต่ความคิดเห็นที่ไม่อยู่ในแบนด์เป็นสิ่งจำเป็นบ่อยครั้งที่จะบันทึกการกำหนดค่า "เริ่มต้น" และสิ่งที่คล้ายกัน การกำหนดค่าต้องไม่เป็น "เอกสารเต็มรูปแบบ" แต่โครงสร้างของข้อมูลที่บันทึกไว้ซึ่งสามารถอ่านได้เมื่อจำเป็น

ฉันเดาว่าหนึ่งสามารถใช้"#": "comment"สำหรับ JSON ที่ "ถูกต้อง"

JSON ไม่สนับสนุนความคิดเห็นโดยกำเนิด แต่คุณสามารถสร้างตัวถอดรหัสของคุณเองหรืออย่างน้อยผู้ประมวลผลก่อนที่จะดึงความคิดเห็นออกมาได้อย่างสมบูรณ์แบบ (ตราบใดที่คุณไม่สนใจความคิดเห็นและไม่ใช้ความคิดเห็นเหล่านั้นเพื่อเป็นแนวทาง )

JSON ไม่มีความคิดเห็น ตัวเข้ารหัส JSON ต้องไม่แสดงความคิดเห็น ตัวถอดรหัส JSON อาจยอมรับและไม่แสดงความคิดเห็น

ความคิดเห็นไม่ควรนำมาใช้เพื่อส่งสิ่งที่มีความหมาย นั่นคือสิ่งที่ JSON มีไว้สำหรับ

Cf: ดักลาส Crockford เขียน JSON ข้อมูลจำเพาะ

ขึ้นอยู่กับไลบรารี JSON ของคุณ Json.NETรองรับความคิดเห็นสไตล์ JavaScript/* commment */สไตล์

ดูคำถาม Stack Overflowอื่น

JSON เหมาะสมกับไฟล์ปรับแต่งและการใช้งานอื่น ๆ ในท้องถิ่นเพราะมันแพร่หลายและเพราะมันง่ายกว่า XML มาก

หากผู้คนมีเหตุผลที่ชัดเจนในการแสดงความคิดเห็นใน JSON เมื่อทำการสื่อสารข้อมูล (ไม่ว่าจะถูกต้องหรือไม่ก็ตาม) อาจเป็นไปได้ว่า JSON อาจถูกแบ่งออกเป็นสองส่วน:

• JSON-COM: JSON บน wire หรือกฎที่ใช้เมื่อสื่อสารข้อมูล JSON
• JSON-DOC: เอกสาร JSON หรือ JSON ในไฟล์หรือในเครื่อง กฎที่กำหนดเอกสาร JSON ที่ถูกต้อง

JSON-DOC จะช่วยให้ความคิดเห็นและความแตกต่างเล็กน้อยอื่น ๆ อาจมีอยู่เช่นการจัดการช่องว่าง Parsers สามารถแปลงจากสเป็คหนึ่งไปเป็นสเปคอื่น

เกี่ยวกับคำกล่าวของดักลาสคร็อคฟอร์ดในประเด็นนี้ (อ้างอิงโดย @Artur Czajka)

สมมติว่าคุณกำลังใช้ JSON เพื่อเก็บไฟล์การกำหนดค่าซึ่งคุณต้องการใส่คำอธิบายประกอบ ไปข้างหน้าและใส่ความคิดเห็นทั้งหมดที่คุณชอบ จากนั้นไปป์ผ่าน JSMin ก่อนที่จะส่งไปยังตัวแยกวิเคราะห์ JSON ของคุณ

เรากำลังพูดถึงปัญหาไฟล์กำหนดค่าทั่วไป (ข้ามภาษา / แพลตฟอร์ม) และเขากำลังตอบกลับด้วยโปรแกรมอรรถประโยชน์ JS เฉพาะ

ตรวจสอบว่า minify เฉพาะของ JSON สามารถใช้งานได้ในทุกภาษา แต่สร้างมาตรฐานนี้เพื่อให้แพร่หลายใน parsers ในทุกภาษาและทุกแพลตฟอร์มเพื่อให้ผู้คนหยุดเสียเวลาโดยขาดคุณสมบัติเนื่องจากมีประโยชน์ในการใช้งานเป็นอย่างดี ฟอรัมออนไลน์และการให้ผู้คนบอกพวกเขาว่าเป็นความคิดที่ไม่ดีหรือแนะนำให้นำความคิดเห็นที่ลอกออกมาจากไฟล์ข้อความมาใช้ง่าย

ปัญหาอื่น ๆ คือการทำงานร่วมกัน สมมติว่าคุณมีไลบรารีหรือ API หรือระบบย่อยใด ๆ ที่มีไฟล์กำหนดค่าหรือไฟล์ข้อมูลบางอย่างที่เกี่ยวข้อง และระบบย่อยนี้จะสามารถเข้าถึงได้จากภาษาที่แตกต่างกัน ถ้าอย่างนั้นคุณจะบอกคนอื่น: อย่าลืมลบความคิดเห็นจากไฟล์ JSON ก่อนส่งต่อให้โปรแกรมแยกวิเคราะห์!

หากคุณใช้JSON5คุณสามารถรวมความคิดเห็นได้

JSON5 เป็นส่วนขยายที่เสนอให้กับ JSONซึ่งมีจุดมุ่งหมายเพื่อให้มนุษย์เขียนและดูแลรักษาได้ง่ายขึ้น ทำได้โดยการเพิ่มฟีเจอร์ไวยากรณ์ขั้นต่ำบางส่วนจาก ECMAScript 5 โดยตรง

ชุดเครื่องมือ JavaScript ของ Dojo Toolkit (อย่างน้อยเป็นรุ่น 1.4) อนุญาตให้คุณใส่ความคิดเห็นใน JSON ของคุณ ความคิดเห็นสามารถเป็น/* */รูปแบบ Dojo Toolkit ใช้ JSON ผ่านการdojo.xhrGet()โทร

ชุดเครื่องมือ JavaScript อื่น ๆ อาจทำงานในทำนองเดียวกัน

สิ่งนี้มีประโยชน์เมื่อทำการทดลองกับโครงสร้างข้อมูลทางเลือก (หรือแม้แต่รายการข้อมูล) ก่อนที่จะเลือกตัวเลือกสุดท้าย

JSON ไม่ได้เป็นโปรโตคอลกรอบ มันเป็นรูปแบบภาษาฟรี ดังนั้นรูปแบบของความคิดเห็นจึงไม่ได้ถูกกำหนดไว้สำหรับ JSON

ตามที่หลายคนแนะนำไว้มีเคล็ดลับบางอย่างเช่นคีย์ซ้ำหรือคีย์เฉพาะ_commentที่คุณสามารถใช้ได้ มันขึ้นอยู่กับคุณ.

คุณสามารถมีความคิดเห็นในJSONPแต่ไม่ใช่ใน JSON บริสุทธิ์ ฉันเพิ่งใช้เวลาหนึ่งชั่วโมงเพื่อให้โปรแกรมทำงานกับตัวอย่างนี้จาก Highcharts: http://www.highcharts.com/samples/data/jsonp.php?filename=aapl-c.json&callback=?

หากคุณไปที่ลิงก์คุณจะเห็น

?(/* AAPL historical OHLC data from the Google Finance API */
[
/* May 2006 */
[1147651200000,67.79],
[1147737600000,64.98],
...
[1368057600000,456.77],
[1368144000000,452.97]
]);

เนื่องจากฉันมีไฟล์ที่คล้ายกันในโฟลเดอร์ท้องถิ่นของฉันจึงไม่มีปัญหากับนโยบายการให้กำเนิดเดียวกันดังนั้นฉันจึงตัดสินใจใช้ JSON แท้ๆ ... และแน่นอน$.getJSONล้มเหลวอย่างเงียบ ๆ เนื่องจากความคิดเห็น

ในที่สุดฉันเพิ่งส่งคำขอ HTTP ด้วยตนเองไปยังที่อยู่ด้านบนและตระหนักว่าเนื้อหาเป็นtext/javascriptเพราะดี JSONP ส่งกลับ JavaScript บริสุทธิ์ ในกรณีนี้ความคิดเห็นที่ได้รับอนุญาต แต่แอปพลิเคชันของฉันคืนประเภทเนื้อหาapplication/jsonดังนั้นฉันจึงต้องลบความคิดเห็น

นี่เป็นคำถาม"คุณสามารถ" และนี่คือ"ใช่"คำตอบ

ไม่คุณไม่ควรใช้สมาชิกวัตถุซ้ำซ้อนเพื่อคัดลอกข้อมูลช่องสัญญาณด้านข้างในการเข้ารหัส JSON (ดูที่ "ชื่อภายในวัตถุควรไม่ซ้ำกัน" ใน RFC )

และใช่คุณสามารถแทรกความคิดเห็นรอบ ๆ JSONซึ่งคุณสามารถแยกวิเคราะห์ได้

แต่ถ้าคุณต้องการวิธีการแทรกและแยกข้อมูลช่องสัญญาณด้านข้างไปยัง JSON ที่ถูกต้องนี่คือคำตอบ เราใช้ประโยชน์จากการแสดงข้อมูลที่ไม่ซ้ำกันในการเข้ารหัส JSON สิ่งนี้ได้รับอนุญาต^*ในส่วนที่สองของ RFC ภายใต้ "ช่องว่างอนุญาตก่อนหรือหลังอักขระโครงสร้างหกตัวใดก็ได้"

^* RFC ระบุเฉพาะ "ช่องว่างอนุญาตก่อนหรือหลังอักขระโครงสร้างหกตัวใด ๆ " โดยไม่กล่าวถึงสตริงตัวเลข "เท็จ", "จริง" และ "null" อย่างชัดเจน การละเว้นนี้ถูกละเว้นในการนำไปใช้ทั้งหมด

ก่อนอื่นให้ตั้งค่า JSON ของคุณโดยการย่อขนาด:

$jsonMin = json_encode(json_decode($json));

จากนั้นเข้ารหัสความคิดเห็นของคุณในรูปแบบไบนารี่:

$hex = unpack('H*', $comment);
$commentBinary = base_convert($hex[1], 16, 2);

จากนั้น steg ไบนารีของคุณ:

$steg = str_replace('0', ' ', $commentBinary);
$steg = str_replace('1', "\t", $steg);

นี่คือผลลัพธ์ของคุณ:

$jsonWithComment = $steg . $jsonMin;

การปฏิเสธความรับผิด: นี่คือ SILLY

จริงๆแล้วมีวิธีในการเพิ่มความคิดเห็นและอยู่ในข้อมูลจำเพาะ (ไม่จำเป็นต้องใช้โปรแกรมแยกวิเคราะห์เพิ่มเติม) มันจะไม่ส่งผลให้เกิดความคิดเห็นที่มนุษย์อ่านได้หากไม่มีการแยกวิเคราะห์ใด ๆ

คุณสามารถละเมิดต่อไปนี้:

ช่องว่างที่ไม่มีนัยสำคัญได้รับอนุญาตก่อนหรือหลังโทเค็นใด ๆ ช่องว่างคือลำดับใด ๆ ของจุดรหัสต่อไปนี้อย่างใดอย่างหนึ่ง: การจัดตารางอักขระ (U + 0009), ตัวดึงบรรทัด (U + 000A), การคืนรถ (U + 000D) และช่องว่าง (U + 0020)

ในทางที่ผิดกฎหมายคุณสามารถใช้วิธีนี้เพื่อเพิ่มความคิดเห็น ตัวอย่างเช่น: เริ่มต้นและสิ้นสุดความคิดเห็นของคุณด้วยแท็บ เข้ารหัสความคิดเห็นใน base3 และใช้อักขระช่องว่างอื่นเพื่อแทนค่า ตัวอย่างเช่น

010212 010202 011000 011000 011010 001012 010122 010121 011021 010202 001012 011022 010212 011020 010202 010202

( hello base threeใน ASCII) แต่แทนที่จะเป็น 0 ใช้พื้นที่สำหรับ 1 ใช้ line feed และ 2 ใช้ carriage return

สิ่งนี้จะทำให้คุณมีช่องว่างที่ไม่สามารถอ่านได้มาก (เว้นแต่คุณจะสร้างปลั๊กอิน IDE เพื่อเข้ารหัส / ถอดรหัสทันที)

ฉันไม่เคยลองสิ่งนี้ด้วยเหตุผลที่ชัดเจนและไม่ควรทำเช่นนั้น

เราใช้strip-json-commentsสำหรับโครงการของเรา รองรับบางสิ่งเช่น:

/*
 * Description 
*/
{
    // rainbows
    "unicorn": /* ❤ */ "cake"
}

เพียงnpm install --save strip-json-commentsติดตั้งและใช้งานเช่น:

var strip_json_comments = require('strip-json-comments')
var json = '{/*rainbows*/"unicorn":"cake"}';
JSON.parse(strip_json_comments(json));
//=> {unicorn: 'cake'}

ในกรณีของฉันฉันจำเป็นต้องใช้ความคิดเห็นเพื่อวัตถุประสงค์ในการแก้ปัญหาก่อนที่จะส่งออกของโครงสร้าง JSON ดังนั้นฉันตัดสินใจที่จะใช้ข้อมูลการดีบักในส่วนหัว HTTP เพื่อหลีกเลี่ยงการทำลายลูกค้า:

header("My-Json-Comment: Yes, I know it's a workaround ;-) ");

JSON ไม่อนุญาตให้แสดงความคิดเห็น เหตุผลก็คือโง่อย่างเต็มที่เพราะคุณสามารถใช้ JSON ตัวเองเพื่อสร้างความคิดเห็นซึ่ง obviates เหตุผลอย่างสิ้นเชิงและโหลดข้อมูลพื้นที่ parser ไม่มีเหตุผลที่ดีเลยสำหรับว่าผลเดียวกันและปัญหาที่อาจเกิดขึ้นเช่นที่พวกเขาอยู่ที่: JSON ไฟล์ที่มีความคิดเห็น

หากคุณพยายามใส่ความคิดเห็นใน (ใช้//หรือ/* */หรือ#เป็นต้น) ตัวแยกวิเคราะห์บางตัวจะล้มเหลวเพราะสิ่งนี้ไม่ได้อยู่ในข้อกำหนดของ JSON อย่างเคร่งครัด ดังนั้นคุณไม่ควรทำเช่นนั้น

นี่คือตัวอย่างที่ระบบจัดการรูปภาพของฉันบันทึกสัญลักษณ์ภาพและข้อมูล (ความคิดเห็น) ที่จัดรูปแบบพื้นฐานเกี่ยวกับพวกเขา (ที่ด้านล่าง):

{
    "Notations": [
        {
            "anchorX": 333,
            "anchorY": 265,
            "areaMode": "Ellipse",
            "extentX": 356,
            "extentY": 294,
            "opacity": 0.5,
            "text": "Elliptical area on top",
            "textX": 333,
            "textY": 265,
            "title": "Notation 1"
        },
        {
            "anchorX": 87,
            "anchorY": 385,
            "areaMode": "Rectangle",
            "extentX": 109,
            "extentY": 412,
            "opacity": 0.5,
            "text": "Rect area\non bottom",
            "textX": 98,
            "textY": 385,
            "title": "Notation 2"
        },
        {
            "anchorX": 69,
            "anchorY": 104,
            "areaMode": "Polygon",
            "extentX": 102,
            "extentY": 136,
            "opacity": 0.5,
            "pointList": [
                {
                    "i": 0,
                    "x": 83,
                    "y": 104
                },
                {
                    "i": 1,
                    "x": 69,
                    "y": 136
                },
                {
                    "i": 2,
                    "x": 102,
                    "y": 132
                },
                {
                    "i": 3,
                    "x": 83,
                    "y": 104
                }
            ],
            "text": "Simple polygon",
            "textX": 85,
            "textY": 104,
            "title": "Notation 3"
        }
    ],
    "imageXW": 512,
    "imageYW": 512,
    "imageName": "lena_std.ato",
    "tinyDocs": {
        "c01": "JSON image notation data:",
        "c02": "-------------------------",
        "c03": "",
        "c04": "This data contains image notations and related area",
        "c05": "selection information that provides a means for an",
        "c06": "image gallery to display notations with elliptical,",
        "c07": "rectangular, polygonal or freehand area indications",
        "c08": "over an image displayed to a gallery visitor.",
        "c09": "",
        "c10": "X and Y positions are all in image space. The image",
        "c11": "resolution is given as imageXW and imageYW, which",
        "c12": "you use to scale the notation areas to their proper",
        "c13": "locations and sizes for your display of the image,",
        "c14": "regardless of scale.",
        "c15": "",
        "c16": "For Ellipses, anchor is the  center of the ellipse,",
        "c17": "and the extents are the X and Y radii respectively.",
        "c18": "",
        "c19": "For Rectangles, the anchor is the top left and the",
        "c20": "extents are the bottom right.",
        "c21": "",
        "c22": "For Freehand and Polygon area modes, the pointList",
        "c23": "contains a series of numbered XY points. If the area",
        "c24": "is closed, the last point will be the same as the",
        "c25": "first, so all you have to be concerned with is drawing",
        "c26": "lines between the points in the list. Anchor and extent",
        "c27": "are set to the top left and bottom right of the indicated",
        "c28": "region, and can be used as a simplistic rectangular",
        "c29": "detect for the mouse hover position over these types",
        "c30": "of areas.",
        "c31": "",
        "c32": "The textx and texty positions provide basic positioning",
        "c33": "information to help you locate the text information",
        "c34": "in a reasonable location associated with the area",
        "c35": "indication.",
        "c36": "",
        "c37": "Opacity is a value between 0 and 1, where .5 represents",
        "c38": "a 50% opaque backdrop and 1.0 represents a fully opaque",
        "c39": "backdrop. Recommendation is that regions be drawn",
        "c40": "only if the user hovers the pointer over the image,",
        "c41": "and that the text associated with the regions be drawn",
        "c42": "only if the user hovers the pointer over the indicated",
        "c43": "region."
    }
}

หากต้องการตัดรายการ JSON เป็นส่วนฉันเพิ่มบรรทัด "ความคิดเห็นจำลอง":

{

"#############################" : "Part1",

"data1"             : "value1",
"data2"             : "value2",

"#############################" : "Part2",

"data4"             : "value3",
"data3"             : "value4"

}