如何在 Json 中加入註解呢? 可以在 Json 裡加入註解嗎?
Json (JavaScript Object Notation) 是目前最流行的資料交換格式,簡單、小巧且易用是他的特色。
但是一大串資料內,難免有需要加入註解(comment)的時候。這時候應該怎麼做呢?
當然官方是不建議這麼做的(www.json.org); 意同,最好的註解就是程式本身😅
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
真妙,key 加 //, 整行包括 value 也會被當成 comment!!!
cola is pig
他也不是真的 comment 啦
只是讓開發者,認知上是 comment 而已