JSON常用的幾種注釋代碼示例
更新時(shí)間：2024年08月17日 11:19:32 作者：viceen
JSON是一種輕量級的數(shù)據(jù)交換格式,下面這篇文章主要給大家介紹了關(guān)于JSON常用的幾種注釋,文中通過代碼介紹的非常詳細(xì),需要的朋友可以參考下
JSON的幾種注釋
本身JSON是沒有類似于Java語法中的
//或者/* */等語法級別的注釋語句的在json文件中用傳統(tǒng)的注釋格式（// /**/）進(jìn)行注釋，是不符合json規(guī)范的。
json里面有自己約定俗成的注釋規(guī)范。
1、在json文件中，采用"//"，其value就是添加的注釋內(nèi)容。
{
"http://": "注釋語句最小值",
"min": "58",
}
2、在需要注釋的字段前面添加?， 當(dāng)然#和_也是可以的。
{
"?min": "注釋語句最小值",
"min": "58",
}
字段注釋
- 增加一個(gè)字段，字段名為
特殊字符(@,#,?等)+正常字段名， 字段的內(nèi)容即為注釋內(nèi)容。 - 為了區(qū)分容易，注釋內(nèi)容盡量避免使用
:,{,},[,]等正常JSON語法一樣的標(biāo)記。
{
"code":1,
"@code":"0=男; 1=女"
}
描述
- 可以參照J(rèn)ava的大段注釋標(biāo)記
/**/作為字段名
{
"/**/": "這是一段描述"
}
語句注釋
- 可以參照J(rèn)ava的注釋標(biāo)記
//作為字段名前綴：
{
"name": "我的名字",
"http://name": "你的名字"
}
完整描述
如果是對一個(gè)JSON文件作完整的描述，則另外寫一個(gè)和字段結(jié)構(gòu)一樣的描述結(jié)構(gòu)，這樣更加清晰。
- 例子
{
"code": 0,
"message": "OK",
"data": {
"id": "12345",
"type": 0,
"name": "我的名字"
"createTime": "2020-05-20"
},
"#data": {
"#id": "用戶ID",
"#type": "0=男; 1=女",
"#name": "姓名",
"#createTime": "創(chuàng)建時(shí)間(yyyy-MM-dd)"
}
}總結(jié)
到此這篇關(guān)于JSON常用的幾種注釋的文章就介紹到這了,更多相關(guān)JSON的幾種注釋內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
這篇文章主要介紹了Hadoop環(huán)境搭建過程中遇到的問題及解決方法，本文給大家介紹的非常詳細(xì)，具有一定的參考借鑒價(jià)值，需要的朋友參考下吧2019-08-08
相比較world這種文檔編輯器而言，Typora更適合寫一些程序相關(guān)的博客，因?yàn)榭梢杂么a+快捷鍵的方式，方便的對文章內(nèi)容進(jìn)行處理，不用在擔(dān)心排版和樣式變形的問題了，在編輯的過程中，就能預(yù)覽到效果2021-12-12
ollama搭建本地ai大模型并應(yīng)用調(diào)用的操作方法
這篇文章詳細(xì)介紹了如何下載、安裝和使用OLLAMA大模型,包括啟動(dòng)配置模型、配置UI界面、搭建本地知識庫、配置文件開發(fā)、環(huán)境變量配置以及通過Golang實(shí)現(xiàn)接口調(diào)用的示例2024-11-11
DataGrip是一款數(shù)據(jù)庫管理客戶端工具，方便連接到數(shù)據(jù)庫服務(wù)器，執(zhí)行sql、創(chuàng)建表、創(chuàng)建索引以及導(dǎo)出數(shù)據(jù)等。這篇文章主要介紹了DataGrip 2020.1 安裝與激活教程,需要的朋友可以參考下2020-09-09
Elasticsearch索引的分片分配Recovery使用講解
這篇文章主要為大家介紹了Elasticsearch索引的分片分配Recovery使用講解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪2022-04-04
這篇文章主要給大家介紹了關(guān)于程序員面試如何提高面試通過率的相關(guān)資料,通過文中介紹的方法可以提高面試概率,讓大家盡快找到好工作,需要的朋友可以參考下2007-04-04
這篇文章介紹了使用Git向GitHub上傳更新內(nèi)容的方法，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2022-04-04
RabbitMQ隊(duì)列中間件消息持久化?確認(rèn)機(jī)制?死信隊(duì)列原理
這篇文章主要介紹了消息隊(duì)列中間件之RabbitMQ消息的持久化、確認(rèn)機(jī)制、死信隊(duì)列原理詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪2023-05-05
MacOS上Homebrew?安裝、配置、更改國內(nèi)鏡像源及使用圖文詳解
Homebrew是一個(gè)強(qiáng)大的包管理器,適用于macOS和Linux系統(tǒng),可以簡化軟件的安裝、升級和卸載過程,它包括brew、homebrew-core、homebrew-cask和homebrew-bottles四個(gè)主要部分,通過tap和cask可以擴(kuò)展功能,安裝圖形界面應(yīng)用,Homebrew還提供了各種命令來管理和維護(hù)已安裝的軟件包2024-11-11
解決appcode打開workspace無法找到xcodeproj項(xiàng)目文件問題
這篇文章主要介紹了解決appcode打開workspace無法找到xcodeproj項(xiàng)目文件問題,本文通過圖文并茂的形式給大家介紹的非常詳細(xì)，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下2021-02-02