jsonc是什麼格式

龙陌發表於2024-04-23
JSON

JSONC，全稱為 JSON with Comments，是一種對標準 JSON（JavaScript Object Notation）格式的擴充套件，允許在 JSON 文件中加入註釋。在標準 JSON 中，註釋是不被允許的，因為它們不符合 JSON 規範。JSONC 為了方便開發者在編寫或維護 JSON 資料時新增解釋性文字或臨時註釋，引入了對單行和多行註釋的支援。

具體來說，JSONC 允許以下兩種型別的註釋：

  1. 單行註釋：
    使用兩個斜槓 (//) 開始，直到行尾。任何緊跟在雙斜槓後的字元都被視為註釋內容，不會被 JSON 解析器識別。

    {
  // This is a single-line comment
  "name": "John Doe",
  "age": 30
}

  2. 多行註釋：
    使用 /* 開始，以 */ 結束。在這對符號之間的所有內容被視為註釋，可以跨越多行。

    {
  /* 
     This is a multi-line comment
     It can span across multiple lines
     and is useful for providing more detailed explanations
  */
  "name": "John Doe",
  "age": 30
}

除了支援註釋之外，JSONC 保留了標準 JSON 的所有其他規則和語法。這意味著 JSONC 檔案仍然是由鍵值對構成的集合，其中鍵是字串，值可以是各種資料型別（如字串、數值、布林值、陣列、物件或 null），並且遵循嚴格的語法要求，如使用逗號分隔鍵值對、使用冒號分隔鍵和值、使用花括號 {} 包裹物件、使用方括號 [] 包裹陣列等。

JSONC 主要用於開發階段，特別是在編輯器、IDE 或配置檔案中，提供給程式設計師一個更友好的方式來編寫和理解 JSON 資料。
然而，需要注意的是，雖然 JSONC 對開發者友好，但並非所有的 JSON 解析器都支援 JSONC。標準 JSON 解析器會因為註釋的存在而無法正確解析 JSONC 檔案。
因此，在實際應用中，尤其是在跨系統或服務間交換資料時，應確保接收端能夠正確處理 JSONC 或在傳送前將 JSONC 轉換為標準 JSON。在某些情況下，如編寫 Node.js 應用時，可以使用專門支援 JSONC 的解析庫來處理此類檔案。

總之，JSONC 是 JSON 的一個變種，主要區別在於它允許在 JSON 文件中新增單行和多行註釋，從而增強了可讀性和可維護性，但其使用受限於接收端對非標準 JSON 擴充套件的支援情況。

相關文章