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


轉載:https://blog.csdn.net/ShiMengRan107/article/details/101761922

 

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文件。使用方法需要依照模塊的要求。


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM