JSON文件內容加註釋的幾種方法

JSON規範，不支持註釋。之所以不允許加註釋，主要是防止：過多的註釋，影響了文件本身的數據載體的目的。

有些文件，尤其是配置文件，加入解釋說明一些數據項的含義，是有必要的。

1、使用JSON5規範

     JSON5規範允許在JSON文件中加入註釋：單行註釋，多行註釋均可。

2、直接用json-schema，使用規範中的註釋字段

     優點：功能強大

     缺點：json-schema與json數據本身分離

3、使用去註釋的庫

     可以使用npm的strip-json-comments庫。

4、使用約定的key作爲註釋字段

     如以"//"， "_comment"，"#####"("#"個數自定) 作爲註釋的key等

5、使用重名key作爲註釋。

     即每個key，使用兩次，第1次做註釋，第2次做實際屬性

6、使用字段key加前綴做註釋key

     常用的前綴還有"#", "_", "__"等。

     優點：沒有重名的字段，完全符合JSON協議。

7、使用支持註釋的配置文件管理模塊

     如npm中rc庫（見：https://github.com/dominictarr/rc），

     或者config（見：https://github.com/lorenwest/node-config）

     缺點：只能用於配置相關的Json文件。使用方法需要依照模塊的要求。