javascript

如何在 Json 中加入註解

如何在 Json 中加入註解呢? 可以在 Json 裡加入註解嗎?
Json (JavaScript Object Notation) 是目前最流行的資料交換格式,簡單、小巧且易用是他的特色。
但是一大串資料內,難免有需要加入註解(comment)的時候。這時候應該怎麼做呢?
當然官方是不建議這麼做的(www.json.org); 意同,最好的註解就是程式本身😅

 

 

如何在 json 內加入註解

以 firebase 的例子來看~

(參考:https://github.com/firebase/quickstart-js/blob/master/messaging/manifest.json)

 

簡單,單純的加入一個新的 key
下面幾種方式也是常見的 key 值


    "//_comment1": "Some browsers will use this to enable push notifications.",

    "//": "Some browsers will use this to enable push notifications.",

    "//comment": "Some browsers will use this to enable push notifications.",

 

 

後記

當然,最好的註解就是沒有註解
json 裡本來就不適合有註解出現

不過在一些特殊情況下,或許可以參考上述方式加入一點簡單的說明
e.g.

{
    "//_comment1": "該資料將於下個版本棄用",
    "cola_type": "cola is pig",
    "//": "最後更新日期",
    "date": "2018-02-20 12:34:56"
}

 

參考:https://stackoverflow.com/questions/244777/can-comments-be-used-in-json

可樂

View Comments

  • 真妙,key 加 //, 整行包括 value 也會被當成 comment!!!

    cola is pig

Share
Published by
可樂

Recent Posts

plain PHP 搭配 Slack 進行錯誤追蹤、回報(Error Tracking、Error Handling)

錯誤追蹤、回報非常重要,看到的錯誤才知道怎麼修。現今 PHP 流行的 Laravel 有很好的 Error Tracking, Error Handling。但 plain PHP 怎麼辦呢? 在 production 為了安全考量會設定…

4 years ago

Drone CI/CD 配合 Github 使用 Rsync 進行 Deploy

jenkins、circleci、travis 或 Gitlab CI 皆為目前暫知名的 CI/CD 服務,各自缺點也不言而喻...過於肥大、收費略高(?)、速度不夠快執問題...此時使用 go language 開發的 Drone 就出現啦,完全 docker 容器化的運行方式讓整個 CI…

4 years ago

Nginx brotli 設定

網頁壓縮技術中 gzip 很好用,deflate 己經過時,但你聽過 brotli 嗎? 有著比 gzip 更好、更快的壓縮效率。看起來利大於弊有什麼不用他的理由嗎?簡單從優、缺點來看 brotli!到底 brotli 布羅特利是什麼、如何設定呢。 目前大多的 web server…

4 years ago

本機使用 Docker 容器內 PHP (wrapper/expose PHP)

為什麼要讓本機使用 Docker 內 PHP? 情境... docker 容器內用的是 PHP 7.4 但你的開發本機還在跑 PHP 5.6 或是更舊,因為 dockerize 的關係會將所有相關環境都轉移到…

4 years ago

為什麼你需要密碼管理工具

為什麼你需要密碼管理工具現代人一天下來需要輸入多少組密碼,工作與生活己經和密碼密不可分! 除了足夠全安的密碼,密碼記錄、儲存的方式又足夠安全嗎?密碼管理工具可以帶來什麼幫助呢? 為什麼你需要密碼管理工具 資安問題!!大多人說著沒做壞事不怕被偷資料、監聽。嚴重曝露出現代人的基本科技素養的低落和無知 🤯 密碼的使用無所不在!! 行動裝置的普及,APP 、手機遊戲、銀行帳戶所有和生活相關的東西都需要密碼!!facebook, line 只要打開 APP 也會輸入密碼只是他是自動輸入、一般情況不可視 (auth token) 一般人最常發生的密碼資安問題…

4 years ago

簡單使用 Mysql Partition 優化查詢

mysql 資料表分區 mysql table partition 從架構上調整 mysql 的查詢效率。mysql DB 的優化可以簡單也能複雜,除了調整設定值。也可以透過水平分割(Horizontal Partitioning)、垂直分割(Vertical Partitioning) 分庫或分表將資料分散儲存減少資料搜尋、group by 時的效能消耗。拆開批次處理,理論上效率都會變好,本文就水平分割的…

4 years ago