有没有在 json 里添加注释的工具

This topic created in 2956 days ago, the information mentioned may be changed or developed.

写接口文档将 api 数据添加注释后就不是 json 结构了不能排版注释对不齐烦躁的一逼

10 replies • 2018-09-30 00:30:58 +08:00

msg7086

Jul 4, 2018

所以你到底是要好的接口文档工具还是要把注释塞进 JSON 里玩呢。

yunye

Jul 4, 2018 via Android

Json 里加注释大概是没吃饱

freestyle

Jul 4, 2018 via iPhone

这就是为什么 json 这么通用却没有流行作为配置文件格式

geelaw

Jul 4, 2018

一个可能的方式是宽松化你的 schema。

{
"@comment": "这是一段注释",
"username": "example",
"email": "[email protected]"
}

geelaw

Jul 4, 2018

@geelaw C 系程序员了，没有分号才对

FanWall

Jul 4, 2018 via Android

非要这样的话，试试当成 js 写？然后用的地方调用 JSON.minify 一下就是 JSON 了
http://www.javascriptoo.com/JSON-minify

SuperMild

Jul 4, 2018

如果是写文档，大可以当作一个 js 的 object 来处理，这样排版就没问题了。真正使用的时候 JSON 没有注释是个正确的设计。

liuzhaowei55

Jul 4, 2018

JSON 没有一个比较好的添加注释的方法。
如果是是为了在接口文档中解释每个 Response 字段的意义，可以再添加一个字典，同样采用 JSON 结构，和 Response 保持一致，但是后边的 value 填写每个字段的解释。

FinnBai

Jul 4, 2018

JSON Schema

http://json-schema.org/

可以了解下合不合适

shsf4

Sep 30, 2018

json5