JSON常用的幾種注釋代碼示例
更新時間：2024年08月17日 11:19:32 作者：viceen
JSON是一種輕量級的數(shù)據(jù)交換格式,下面這篇文章主要給大家介紹了關(guān)于JSON常用的幾種注釋,文中通過代碼介紹的非常詳細,需要的朋友可以參考下
JSON的幾種注釋
本身JSON是沒有類似于Java語法中的
//或者/* */等語法級別的注釋語句的在json文件中用傳統(tǒng)的注釋格式（// /**/）進行注釋，是不符合json規(guī)范的。
json里面有自己約定俗成的注釋規(guī)范。
1、在json文件中，采用"//"，其value就是添加的注釋內(nèi)容。
{
"http://": "注釋語句最小值",
"min": "58",
}
2、在需要注釋的字段前面添加?， 當然#和_也是可以的。
{
"?min": "注釋語句最小值",
"min": "58",
}
字段注釋
- 增加一個字段，字段名為
特殊字符(@,#,?等)+正常字段名， 字段的內(nèi)容即為注釋內(nèi)容。 - 為了區(qū)分容易，注釋內(nèi)容盡量避免使用
:,{,},[,]等正常JSON語法一樣的標記。
{
"code":1,
"@code":"0=男; 1=女"
}
描述
- 可以參照Java的大段注釋標記
/**/作為字段名
{
"/**/": "這是一段描述"
}
語句注釋
- 可以參照Java的注釋標記
//作為字段名前綴：
{
"name": "我的名字",
"http://name": "你的名字"
}
完整描述
如果是對一個JSON文件作完整的描述，則另外寫一個和字段結(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)建時間(yyyy-MM-dd)"
}
}總結(jié)
到此這篇關(guān)于JSON常用的幾種注釋的文章就介紹到這了,更多相關(guān)JSON的幾種注釋內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
HTTP?413狀態(tài)碼詳解與前端處理請求體過大教程
狀態(tài)碼是服務(wù)器在處理請求后返回給客戶端的一組標準化數(shù)字代碼,它們通常與特定的含義相聯(lián)系,并且可以幫助開發(fā)者快速定位問題,這篇文章主要介紹了HTTP?413狀態(tài)碼詳解與前端處理請求體過大的相關(guān)資料,需要的朋友可以參考下2026-01-01
鴻蒙NEXT元服務(wù)之如何利用App?Linking實現(xiàn)無縫跳轉(zhuǎn)與二維碼拉起
本文介紹了如何使用AppLinking技術(shù)實現(xiàn)元服務(wù)之間的無縫跳轉(zhuǎn),并通過生成二維碼的方式快速拉起元服務(wù),從而簡化用戶操作流程,增強應(yīng)用的互動性和推廣效率,感興趣的朋友跟隨小編一起看看吧2024-11-11
ol7.7安裝部署4節(jié)點spark3.0.0分布式集群的詳細教程
這篇文章主要介紹了安裝部署4節(jié)點spark3.0.0分布式集群，本文給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值,需要的朋友可以參考下2020-07-07
分別使用vue和Android實現(xiàn)長按券碼復制功能
最近分別用vue和Android實現(xiàn)了一個券碼復制功能，長按券碼會在上方彈出一個拷貝的icon提示，點擊icon將券碼內(nèi)容復制到剪貼板。下面小編給大家?guī)韺崿F(xiàn)代碼，需要的朋友參考下吧2019-10-10
ArcGIS Pro 是 Esri 提供的功能全面的專業(yè)桌面 GIS 應(yīng)用程序,這篇文章主要介紹了ArcGIS Pro 按照字段進行融合或拆分,需要的朋友可以參考下2024-02-02
nGrinder是NHN公司用Java語言開發(fā)的一款的基于Grinder開發(fā)的開源B/S Web性能測試平臺，具有友好簡潔的用戶界面和分布式測試功能，本文給大家分享nGrinder性能工具源碼安裝部署過程，一起看看吧2021-05-05
gradle+shell實現(xiàn)自動系統(tǒng)簽名
這篇文章主要介紹了gradle+shell實現(xiàn)自動系統(tǒng)簽名的相關(guān)資料,需要的朋友可以參考下2019-08-08
這篇文章主要為大家介紹了Elasticsearch之基本查詢及組合查詢操作示例，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪2022-04-04
本文主要介紹了postman批量執(zhí)行接口測試，文中通過示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下2022-03-03
這篇文章主要介紹了好玩的vbs微信小程序之語言播報功能,非常好玩有趣，需要的朋友跟隨小編一起看看吧2019-09-09