Nhận xét có thể được sử dụng trong JSON không?

Tôi có thể sử dụng các bình luận bên trong một tệp JSON không? Nếu vậy thì thế nào?

Không.

Tất cả JSON phải là dữ liệu và nếu bạn bao gồm một nhận xét thì nó cũng sẽ là dữ liệu.

Bạn có thể có một yếu tố dữ liệu được chỉ định gọi là "_comment"(hoặc một cái gì đó) sẽ bị bỏ qua bởi các ứng dụng sử dụng dữ liệu JSON.

Có lẽ bạn nên có nhận xét tốt hơn trong các quy trình tạo / nhận JSON, vì họ phải biết trước dữ liệu JSON sẽ là gì hoặc ít nhất là cấu trúc của nó.

Nhưng nếu bạn quyết định:

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

Không , nhận xét về biểu mẫu //…hoặc /*…*/không được phép trong JSON. Câu trả lời này dựa trên:

• http://www.json.org
• RFC 4627 : application/jsonLoại phương tiện cho ký hiệu đối tượng JavaScript (JSON)
• RFC 8259 Định dạng trao đổi dữ liệu ký hiệu đối tượng JavaScript (JSON) (thay thế RFCs 4627, 7158, 7159)

Bao gồm ý kiến ​​nếu bạn chọn; loại bỏ chúng bằng một công cụ khai thác trước khi phân tích hoặc truyền.

Tôi vừa phát hành JSON.minify () để loại bỏ các bình luận và khoảng trắng từ một khối JSON và làm cho JSON hợp lệ có thể được phân tích cú pháp. Vì vậy, bạn có thể sử dụng nó như:

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

Khi tôi phát hành nó, tôi đã nhận được một phản ứng dữ dội về việc mọi người không đồng ý với ý tưởng của nó, vì vậy tôi quyết định rằng tôi sẽ viết một bài đăng blog toàn diện về lý do tại sao các bình luận có ý nghĩa trong JSON . Nó bao gồm nhận xét đáng chú ý này từ người tạo JSON:

Giả sử bạn đang sử dụng JSON để giữ các tệp cấu hình mà bạn muốn chú thích. Đi trước và chèn tất cả các ý kiến ​​bạn thích. Sau đó chuyển nó qua JSMin trước khi đưa nó cho trình phân tích cú pháp JSON của bạn. - Douglas Crockford, 2012

Hy vọng rằng điều đó hữu ích cho những người không đồng ý với lý do tại sao JSON.minify () có thể hữu ích.

Nhận xét đã bị xóa khỏi JSON theo thiết kế.

Tôi đã xóa các nhận xét khỏi JSON vì tôi thấy mọi người đang sử dụng chúng để giữ các chỉ thị phân tích cú pháp, một thực tế sẽ phá hủy khả năng tương tác. Tôi biết rằng việc thiếu bình luận làm cho một số người buồn, nhưng không nên.

Giả sử bạn đang sử dụng JSON để giữ các tệp cấu hình mà bạn muốn chú thích. Đi trước và chèn tất cả các ý kiến ​​bạn thích. Sau đó chuyển nó qua JSMin trước khi đưa nó cho trình phân tích cú pháp JSON của bạn.

Nguồn: Tuyên bố công khai của Douglas Crockford trên G +

TUYÊN BỐ TỪ CHỐI: BẢO HÀNH CỦA BẠN LÀ VOID

Như đã được chỉ ra, hack này lợi dụng việc thực hiện thông số kỹ thuật. Không phải tất cả các trình phân tích cú pháp JSON sẽ hiểu loại JSON này. Trình phân tích cú pháp đặc biệt sẽ bị sặc.

Đó là một sự tò mò thú vị, nhưng bạn thực sự không nên sử dụng nó cho bất cứ điều gì cả . Dưới đây là câu trả lời ban đầu.

Tôi đã tìm thấy một hack nhỏ cho phép bạn đặt các bình luận trong một tệp JSON sẽ không ảnh hưởng đến việc phân tích cú pháp hoặc thay đổi dữ liệu được trình bày theo bất kỳ cách nào.

Có vẻ như khi khai báo một đối tượng bằng chữ, bạn có thể chỉ định hai giá trị có cùng khóa và giá trị cuối cùng được ưu tiên. Dù bạn có tin hay không, hóa ra các trình phân tích cú pháp JSON cũng hoạt động theo cùng một cách. Vì vậy, chúng ta có thể sử dụng điều này để tạo các bình luận trong JSON nguồn sẽ không có trong biểu diễn đối tượng được phân tích cú pháp.

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

Nếu chúng tôi áp dụng kỹ thuật này, tệp JSON được nhận xét của bạn có thể trông như thế này:

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

Đoạn mã trên là JSON hợp lệ . Nếu bạn phân tích cú pháp, bạn sẽ nhận được một đối tượng như thế này:

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

Điều đó có nghĩa là không có dấu vết của các bình luận, và chúng sẽ không có tác dụng phụ kỳ lạ.

Chúc mừng hack!

JSON không hỗ trợ bình luận. Nó cũng không bao giờ có ý định được sử dụng cho các tập tin cấu hình, nơi cần bình luận.

Hjson là một định dạng tập tin cấu hình cho con người. Cú pháp thư giãn, ít sai lầm hơn, bình luận nhiều hơn.

Xem hjson.org để biết các thư viện JavaScript, Java, Python, PHP, Rust, Go, Ruby và C #.

Cân nhắc sử dụng YAML. Nó gần như là một superset của JSON (hầu như tất cả JSON hợp lệ là YAML hợp lệ) và nó cho phép nhận xét.

Bạn không thể. Ít nhất đó là kinh nghiệm của tôi từ cái nhìn nhanh vào json.org .

JSON có cú pháp được trực quan hóa trên trang đó. Không có bất kỳ lưu ý về ý kiến.

Nhận xét không phải là một tiêu chuẩn chính thức, mặc dù một số trình phân tích cú pháp hỗ trợ nhận xét kiểu C ++. Một cái mà tôi sử dụng là JsonCpp . Trong các ví dụ có cái này:

// 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 không xác nhận điều này. Vì vậy, ý kiến ​​là một phần mở rộng cụ thể của trình phân tích cú pháp và không chuẩn.

Một trình phân tích cú pháp khác là JSON5 .

Một thay thế cho JSON TOML .

Một thay thế khác là jsonc .

Bạn nên viết một lược đồ JSON thay thế. Lược đồ JSON hiện là một đặc tả dự thảo Internet được đề xuất. Ngoài tài liệu, lược đồ cũng có thể được sử dụng để xác thực dữ liệu JSON của bạn.

Thí dụ:

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

Bạn có thể cung cấp tài liệu bằng cách sử dụng thuộc tính lược đồ mô tả .

Nếu bạn đang sử dụng Jackson làm trình phân tích cú pháp JSON của mình thì đây là cách bạn kích hoạt nó để cho phép nhận xét:

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

Sau đó, bạn có thể có ý kiến ​​như thế này:

{
  key: "value" // Comment
}

Và bạn cũng có thể có ý kiến ​​bắt đầu bằng #cách cài đặt:

mapper.configure(Feature.ALLOW_YAML_COMMENTS, true);

Nhưng nói chung (như đã trả lời trước), đặc điểm kỹ thuật không cho phép bình luận.

Đây là những gì tôi tìm thấy trong tài liệu Google Firebase cho phép bạn đưa nhận xét vào 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 được sử dụng để hỗ trợ các bình luận, nhưng chúng đã bị lạm dụng và bị xóa khỏi tiêu chuẩn.

Từ người tạo ra JSON:

Tôi đã xóa các nhận xét khỏi JSON vì tôi thấy mọi người đang sử dụng chúng để giữ các chỉ thị phân tích cú pháp, một thực tế sẽ phá hủy khả năng tương tác. Tôi biết rằng việc thiếu bình luận làm cho một số người buồn, nhưng không nên. - Douglas Crockford, 2012

Trang web JSON chính thức có tại JSON.org . JSON được định nghĩa là một tiêu chuẩn của ECMA International. Luôn luôn có một quy trình kiến ​​nghị để có các tiêu chuẩn sửa đổi. Không chắc là các chú thích sẽ được thêm vào tiêu chuẩn JSON vì nhiều lý do.

JSON theo thiết kế là một sự thay thế dễ dàng được thiết kế ngược (phân tích cú pháp của con người) với XML. Nó được đơn giản hóa đến mức các chú thích là không cần thiết. Nó thậm chí không phải là một ngôn ngữ đánh dấu. Mục tiêu là sự ổn định và tương tác.

Bất cứ ai hiểu mối quan hệ "có-có" của hướng đối tượng đều có thể hiểu bất kỳ cấu trúc JSON nào - đó là toàn bộ vấn đề. Nó chỉ là một biểu đồ chu kỳ có hướng (DAG) với các thẻ nút (cặp khóa / giá trị), là một cấu trúc dữ liệu gần phổ quát.

Chú thích này chỉ yêu cầu có thể là "// Đây là các thẻ DAG". Các tên chính có thể là thông tin theo yêu cầu, cho phép tính chất ngữ nghĩa tùy ý.

Bất kỳ nền tảng nào cũng có thể phân tích cú pháp JSON chỉ bằng một vài dòng mã. XML yêu cầu các thư viện OO phức tạp không khả thi trên nhiều nền tảng.

Các chú thích sẽ làm cho JSON làm cho ít tương tác hơn. Đơn giản là không có gì khác để thêm vào, trừ khi thứ bạn thực sự cần là ngôn ngữ đánh dấu (XML) và không quan tâm nếu dữ liệu bền vững của bạn dễ dàng được phân tích cú pháp.

NHƯNG là người tạo ra JSON cũng quan sát thấy, luôn có sự hỗ trợ của đường dẫn JS cho các bình luận:

Đi trước và chèn tất cả các ý kiến ​​bạn thích. Sau đó chuyển nó qua JSMin trước khi đưa nó cho trình phân tích cú pháp JSON của bạn. - Douglas Crockford, 2012

Nếu tệp văn bản của bạn, là một chuỗi JSON, sẽ được một chương trình nào đó đọc, thì việc loại bỏ các nhận xét kiểu C hoặc C ++ sẽ khó khăn như thế nào trước khi sử dụng nó?

Trả lời: Nó sẽ là một lót. Nếu bạn làm điều đó thì các tệp JSON có thể được sử dụng làm các tệp cấu hình.

Nếu bạn đang sử dụng thư viện Newtonsoft.Json với ASP.NET để đọc / giải nén, bạn có thể sử dụng các nhận xét trong nội dung JSON:

// "tên": "chuỗi"

// "id": int

hoặc là

/* Đây là một

ví dụ bình luận * /

PS: Nhận xét một dòng chỉ được hỗ trợ với hơn 6 phiên bản Newtonsoft Json.

Lưu ý bổ sung cho những người không thể nghĩ ra: Tôi sử dụng định dạng JSON cho các cài đặt cơ bản trong ứng dụng web ASP.NET mà tôi đã tạo. Tôi đọc tệp, chuyển đổi nó thành đối tượng cài đặt với thư viện Newtonsoft và sử dụng nó khi cần thiết.

Tôi thích viết bình luận về từng cài đặt riêng lẻ trong chính tệp JSON và tôi thực sự không quan tâm đến tính toàn vẹn của định dạng JSON miễn là thư viện tôi sử dụng là ổn với nó.

Tôi nghĩ rằng đây là một cách 'dễ sử dụng / hiểu' hơn là tạo một tệp 'settings.README' riêng biệt và giải thích các cài đặt trong đó.

Nếu bạn có một vấn đề với loại sử dụng này; xin lỗi, thần đèn đã tắt đèn Mọi người sẽ tìm thấy các cách sử dụng khác cho định dạng JSON và bạn không thể làm gì về nó.

Ý tưởng đằng sau JSON là cung cấp trao đổi dữ liệu đơn giản giữa các ứng dụng. Chúng thường dựa trên web và ngôn ngữ là JavaScript.

Tuy nhiên, nó không thực sự cho phép nhận xét như vậy, tuy nhiên, việc chuyển một nhận xét là một trong các cặp tên / giá trị trong dữ liệu chắc chắn sẽ hoạt động, mặc dù dữ liệu đó rõ ràng cần phải được bỏ qua hoặc xử lý cụ thể bằng mã phân tích.

Tất cả những gì đã nói, đó không phải là ý định rằng tệp JSON nên chứa các bình luận theo nghĩa truyền thống. Nó chỉ nên là dữ liệu.

Hãy xem trang web JSON để biết thêm chi tiết.

Tôi chỉ gặp điều này cho các tập tin cấu hình. Tôi không muốn sử dụng định dạng XML (dài dòng, đồ họa, xấu, khó đọc) hoặc "ini" (không phân cấp, không có tiêu chuẩn thực, v.v.) hoặc định dạng "Thuộc tính" của Java (như .ini).

JSON có thể làm tất cả những gì họ có thể làm, nhưng đó là cách ít dài dòng hơn và dễ đọc hơn cho con người - và các trình phân tích cú pháp rất dễ dàng và có mặt ở nhiều ngôn ngữ. Nó chỉ là một cây dữ liệu. Nhưng các bình luận ngoài băng thường là một điều cần thiết để ghi lại các cấu hình "mặc định" và tương tự. Cấu hình không bao giờ là "tài liệu đầy đủ", nhưng cây dữ liệu đã lưu có thể đọc được khi cần.

Tôi đoán người ta có thể sử dụng "#": "comment", cho JSON "hợp lệ".

JSON không hỗ trợ bình luận một cách tự nhiên, nhưng bạn có thể tạo bộ giải mã của riêng mình hoặc ít nhất là bộ xử lý trước để loại bỏ các bình luận, điều đó hoàn toàn tốt (miễn là bạn bỏ qua các bình luận và không sử dụng chúng để hướng dẫn cách ứng dụng của bạn xử lý dữ liệu JSON ).

JSON không có ý kiến. Một bộ mã hóa JSON PHẢI KHÔNG đưa ra các bình luận. Một bộ giải mã JSON CÓ THỂ chấp nhận và bỏ qua các bình luận.

Bình luận không bao giờ nên được sử dụng để truyền tải bất cứ điều gì có ý nghĩa. Đó là những gì JSON dành cho.

Cf: Douglas Crockford, tác giả của thông số JSON .

Nó phụ thuộc vào thư viện JSON của bạn. Json.NET hỗ trợ các bình luận kiểu JavaScript , /* commment */.

Xem một câu hỏi khác về Stack Overflow .

JSON có ý nghĩa rất lớn đối với các tệp cấu hình và cách sử dụng cục bộ khác vì nó phổ biến và vì nó đơn giản hơn nhiều so với XML.

Nếu mọi người có lý do mạnh mẽ để không có nhận xét trong JSON khi truyền dữ liệu (dù hợp lệ hay không), thì có thể JSON có thể được chia thành hai:

• JSON-COM: JSON trên dây hoặc quy tắc áp dụng khi giao tiếp dữ liệu JSON.
• JSON-DOC: Tài liệu JSON hoặc JSON trong tệp hoặc cục bộ. Các quy tắc xác định một tài liệu JSON hợp lệ.

JSON-DOC sẽ cho phép các bình luận và các khác biệt nhỏ khác có thể tồn tại như xử lý khoảng trắng. Trình phân tích cú pháp có thể dễ dàng chuyển đổi từ thông số này sang thông số khác.

Liên quan đến nhận xét của Douglas Crockford về vấn đề này (được tham khảo bởi @Artur Czajka)

Giả sử bạn đang sử dụng JSON để giữ các tệp cấu hình mà bạn muốn chú thích. Đi trước và chèn tất cả các ý kiến ​​bạn thích. Sau đó chuyển nó qua JSMin trước khi đưa nó cho trình phân tích cú pháp JSON của bạn.

Chúng ta đang nói về một vấn đề tệp cấu hình chung (ngôn ngữ chéo / nền tảng) và anh ấy đang trả lời với một tiện ích cụ thể của JS!

Chắc chắn rằng một minify cụ thể của JSON có thể được triển khai bằng bất kỳ ngôn ngữ nào, nhưng tiêu chuẩn hóa nó để nó trở nên phổ biến trên các trình phân tích cú pháp trong tất cả các ngôn ngữ và nền tảng để mọi người ngừng lãng phí thời gian của họ vì họ có các trường hợp sử dụng tốt cho nó, tìm kiếm vấn đề diễn đàn trực tuyến và để mọi người nói với họ đó là một ý tưởng tồi hoặc cho thấy thật dễ dàng để thực hiện tước bình luận ra khỏi các tệp văn bản.

Vấn đề còn lại là khả năng tương tác. Giả sử bạn có thư viện hoặc API hoặc bất kỳ loại hệ thống con nào có một số tệp cấu hình hoặc dữ liệu được liên kết với nó. Và hệ thống con này sẽ được truy cập từ các ngôn ngữ khác nhau. Sau đó, bạn có đi nói với mọi người không: nhân tiện đừng quên loại bỏ các nhận xét từ các tệp JSON trước khi chuyển chúng cho trình phân tích cú pháp!

Nếu bạn sử dụng JSON5, bạn có thể bao gồm các ý kiến.

JSON5 là một phần mở rộng được đề xuất cho JSON nhằm mục đích giúp con người dễ dàng viết và bảo trì bằng tay hơn. Nó thực hiện điều này bằng cách thêm một số tính năng cú pháp tối thiểu trực tiếp từ ECMAScript 5.

Bộ công cụ JavaScript của Bộ công cụ Dojo (ít nhất là từ phiên bản 1.4), cho phép bạn đưa các nhận xét vào JSON của mình. Các ý kiến ​​có thể có /* */định dạng. Bộ công cụ Dojo tiêu thụ JSON thông qua dojo.xhrGet()cuộc gọi.

Các bộ công cụ JavaScript khác có thể hoạt động tương tự.

Điều này có thể hữu ích khi thử nghiệm các cấu trúc dữ liệu thay thế (hoặc thậm chí danh sách dữ liệu) trước khi chọn tùy chọn cuối cùng.

JSON không phải là một giao thức đóng khung . Nó là một định dạng ngôn ngữ miễn phí . Vì vậy, định dạng của một nhận xét không được xác định cho JSON.

Như nhiều người đã đề xuất, có một số thủ thuật, ví dụ, các khóa trùng lặp hoặc một khóa cụ thể _commentmà bạn có thể sử dụng. Tuỳ bạn.

Bạn có thể có ý kiến ​​trong JSONP , nhưng không có JSON thuần túy. Tôi vừa dành một giờ để cố gắng làm cho chương trình của mình hoạt động với ví dụ này từ Highcharts: http://www.highcharts.com/samples/data/jsonp.php?filename=aapl-c.json&callback=?

Nếu bạn theo liên kết, bạn sẽ thấy

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

Vì tôi có một tệp tương tự trong thư mục cục bộ của mình, không có vấn đề gì với chính sách Cùng nguồn gốc , vì vậy tôi đã quyết định sử dụng JSON thuần túy ... và tất nhiên, $.getJSONđã thất bại trong âm thầm vì các bình luận.

Cuối cùng, tôi vừa gửi một yêu cầu HTTP thủ công đến địa chỉ trên và nhận ra rằng kiểu nội dung là text/javascriptdo, JSONP trả về JavaScript thuần. Trong trường hợp này ý kiến được cho phép . Nhưng ứng dụng của tôi trả về kiểu nội dung application/json, vì vậy tôi phải xóa các bình luận.

Đây là một câu hỏi "bạn có thể" . Và đây là câu trả lời "có" .

Không, bạn không nên sử dụng các thành viên đối tượng trùng lặp để nhét dữ liệu kênh bên vào mã hóa JSON. (Xem "Tên trong một đối tượng NÊN là duy nhất" trong RFC ).

Và vâng, bạn có thể chèn các bình luận xung quanh JSON mà bạn có thể phân tích.

Nhưng nếu bạn muốn một cách chèn và trích xuất dữ liệu kênh phụ tùy ý vào JSON hợp lệ, đây là một câu trả lời. Chúng tôi tận dụng sự biểu diễn dữ liệu không phải là duy nhất trong mã hóa JSON. Điều này được cho phép ^* trong phần hai của RFC trong "khoảng trắng được phép trước hoặc sau bất kỳ sáu ký tự cấu trúc nào".

^* RFC chỉ nêu "khoảng trắng được phép trước hoặc sau bất kỳ sáu ký tự cấu trúc nào", không đề cập rõ ràng đến chuỗi, số, "sai", "đúng" và "null". Thiếu sót này được bỏ qua trong TẤT CẢ các triển khai.

Đầu tiên, chuẩn hóa JSON của bạn bằng cách thu nhỏ nó:

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

Sau đó mã hóa nhận xét của bạn trong nhị phân:

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

Sau đó steg nhị phân của bạn:

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

Đây là đầu ra của bạn:

$jsonWithComment = $steg . $jsonMin;

TUYÊN BỐ TỪ CHỐI: ĐÂY LÀ SILLY

Thực sự có một cách để thêm ý kiến ​​và ở trong thông số kỹ thuật (không cần thêm trình phân tích cú pháp). Nó sẽ không dẫn đến các bình luận có thể đọc được mà không có bất kỳ loại phân tích cú pháp nào.

Bạn có thể lạm dụng như sau:

Khoảng trắng không đáng kể được cho phép trước hoặc sau bất kỳ mã thông báo nào. Khoảng trắng là bất kỳ chuỗi nào của một hoặc nhiều điểm mã sau: lập bảng ký tự (U + 0009), nguồn cấp dữ liệu (U + 000A), trả về vận chuyển (U + 000D) và khoảng trắng (U + 0020).

Theo cách hacky, bạn có thể lạm dụng điều này để thêm một bình luận. Ví dụ: bắt đầu và kết thúc bình luận của bạn bằng một tab. Mã hóa nhận xét trong base3 và sử dụng các ký tự khoảng trắng khác để thể hiện chúng. Ví dụ.

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

( hello base threetrong ASCII) Nhưng thay vì 0 sử dụng không gian, cho 1 sử dụng nguồn cấp dữ liệu và cho 2 sử dụng trả lại vận chuyển.

Điều này sẽ chỉ để lại cho bạn rất nhiều khoảng trắng không thể đọc được (trừ khi bạn tạo một plugin IDE để mã hóa / giải mã nó một cách nhanh chóng).

Tôi thậm chí không bao giờ thử điều này, vì lý do rõ ràng và bạn cũng không nên.

Chúng tôi đang sử dụng strip-json-commentscho dự án của chúng tôi. Nó hỗ trợ một cái gì đó như:

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

Đơn giản chỉ cần npm install --save strip-json-commentscài đặt và sử dụng nó như:

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

Trong trường hợp của tôi, tôi cần sử dụng các nhận xét cho mục đích gỡ lỗi, trước khi xuất cấu trúc JSON. Vì vậy, tôi quyết định sử dụng thông tin gỡ lỗi trong tiêu đề HTTP, để tránh phá vỡ ứng dụng khách:

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

JSON không cho phép bình luận, mỗi lần. Lý do là hoàn toàn ngu ngốc, bởi vì bạn có thể sử dụng JSON bản thân để tạo ra ý kiến, mà obviates sự lập luận hoàn toàn, và tải các không gian dữ liệu phân tích cú pháp không có lý do tốt ở tất cả cho chính xác kết quả tương tự và các vấn đề tiềm năng, chẳng hạn như họ là: a JSON tập tin có ý kiến.

Nếu bạn cố gắng đưa ý kiến ​​vào (sử dụng //hoặc /* */hoặc #ví dụ), thì một số trình phân tích cú pháp sẽ thất bại vì điều này hoàn toàn không nằm trong đặc tả JSON. Vì vậy, bạn không bao giờ nên làm điều đó.

Đây là một ví dụ, trong đó hệ thống xử lý hình ảnh của tôi đã lưu các ký hiệu hình ảnh và một số thông tin định dạng (bình luận) cơ bản liên quan đến chúng (ở phía dưới):

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

Để cắt một mục JSON thành các phần tôi thêm dòng "bình luận giả":

{

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

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

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

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

}