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

2018-07-04 11:35:09 +08:00
 zhazi

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

3177 次点击
所在节点    问与答
10 条回复
msg7086
2018-07-04 13:21:12 +08:00
所以你到底是要好的接口文档工具还是要把注释塞进 JSON 里玩呢。
yunye
2018-07-04 13:23:32 +08:00
Json 里加注释 大概是没吃饱
freestyle
2018-07-04 13:25:50 +08:00
这就是为什么 json 这么通用却没有流行作为配置文件格式
geelaw
2018-07-04 13:37:16 +08:00
一个可能的方式是宽松化你的 schema。

{
"@comment": "这是一段注释",
"username": "example",
"email": "someone@example.com"
}
geelaw
2018-07-04 13:37:59 +08:00
@geelaw C 系程序员了,没有分号才对
FanWall
2018-07-04 13:48:47 +08:00
非要这样的话,试试当成 js 写?然后用的地方调用 JSON.minify 一下就是 JSON 了
http://www.javascriptoo.com/JSON-minify
SuperMild
2018-07-04 14:09:44 +08:00
如果是写文档,大可以当作一个 js 的 object 来处理,这样排版就没问题了。真正使用的时候 JSON 没有注释是个正确的设计。
liuzhaowei55
2018-07-04 14:17:06 +08:00
JSON 没有一个比较好的添加注释的方法。
如果是是为了在接口文档中解释每个 Response 字段的意义,可以再添加一个字典,同样采用 JSON 结构,和 Response 保持一致,但是后边的 value 填写每个字段的解释。
baiyi
2018-07-04 15:12:55 +08:00
JSON Schema

http://json-schema.org/

可以了解下合不合适
shsf4
2018-09-30 00:30:58 +08:00
json5

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/468013

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX