写接口文档 将 api 数据添加注释后就不是 json 结构了 不能排版 注释对不齐烦躁的一逼
写接口文档 将 api 数据添加注释后就不是 json 结构了 不能排版 注释对不齐烦躁的一逼
|
msg7086Jul 4, 2018
1
所以你到底是要好的接口文档工具还是要把注释塞进 JSON 里玩呢。
|
|
yunyeJul 4, 2018 via Android
2
Json 里加注释 大概是没吃饱
|
|
freestyleJul 4, 2018 via iPhone
3
这就是为什么 json 这么通用却没有流行作为配置文件格式
|
|
geelawJul 4, 2018
4
|
|
FanWallJul 4, 2018 via Android
6
非要这样的话,试试当成 js 写?然后用的地方调用 JSON.minify 一下就是 JSON 了
http://www.javascriptoo.com/JSON-minify |
|
SuperMildJul 4, 2018
7
如果是写文档,大可以当作一个 js 的 object 来处理,这样排版就没问题了。真正使用的时候 JSON 没有注释是个正确的设计。
|
|
liuzhaowei55Jul 4, 2018
8
JSON 没有一个比较好的添加注释的方法。
如果是是为了在接口文档中解释每个 Response 字段的意义,可以再添加一个字典,同样采用 JSON 结构,和 Response 保持一致,但是后边的 value 填写每个字段的解释。 |
|
FinnBaiJul 4, 2018
9
|
|
shsf4Sep 30, 2018
10
json5
|