可以加上註解的 JSON 擴充格式 JSONC

一般的 JSON 格式如下:
    
{
  "username": "Ruyut",
  "age": 100,
  "email": "a@ruyut.com",
  "interests": [
    "coding",
    "reading",
    "music"
  ],
  "married": false
}
    

如果想要寫註解,通常會使用下列方式:
    
{
  "//": "使用者名稱",
  "username": "Ruyut",
  "//": "年齡",
  "age": 100,
  "email": "a@ruyut.com",
  "interests": [
    "coding",
    "reading",
    "music"
  ],
  "married": false
}
    

或是使用 //username 和 //age 等方式,畢竟名稱不能重複。

不過後來有推出第三方 JSON 擴充格式 JSON with Comments 簡稱 JSONC ,副檔名就是 .jsonc,可以很簡單的使用:
    
{
  "username": "Ruyut", // 使用者名稱
  "age": 100, // 年齡 
  "email": "a@ruyut.com",
  "interests": [
    "coding",
    "reading",
    "music"
  ],
  "married": false
}
    

包含 VSCode, JetBrains 等編輯器都有內建支援,非常方便

程式中要使用也越來越簡單,不過因為是第三方擴充,並不是 JSON 原始的定義,比較少可以直接讀取,不過例如 C# 的 C# System.Text.Json 就可以透過忽略註解(JsonCommentHandling.Skip)的方式間接的讀取,並沒有到無法使用。

留言

張貼留言

如果有任何問題、建議、想說的話或文章題目推薦,都歡迎留言或來信: a@ruyut.com