JSON檔案內容加注釋的幾種方法

2022-02-02 09:27:33 字數 582 閱讀 8772

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庫(見:

或者config(見:

JSON新增注釋的問題

json有兩種資料結構 名稱 值對的集合 key value樣式 值的有序列表 就是array 而在json的文件中說明只要是不符合上面兩種結構的都不被支援,並提示錯誤 新增注釋 或者 在json檔案中是不允許的 那麼json如何才能加注釋?1.使用key value新增 2.使用json.mini...

可新增注釋的json配置檔案 HJSON

用nodejs做了幾個專案,期間一直使用json檔案作為配置檔案,對其不能加注釋 單引號 雙引號等格式問題在前期也踩了不少坑,尤其是多程式猴一起寫 時候,哪個知道那麼多配置名稱是啥子意思,不得不同時維護乙個說明文件,但是我懶,寫 這麼高效的事情,沒事開啟個word文件看,忍不了。直到有一天,我發現了...

對python的檔案內注釋 help注釋方法

目的 在help 模組名 時,能夠看見檔案裡面的注釋。首先,在檔案的最開頭,如果有個多行注釋 三引號 就會將注釋寫入 doc 變數,在help檢視時,可以看見這個變數。如果還需要輸出函式,則可以將函式放入 all 變數。all search fix hello parser all裡面www.cpp...