首页   注册   登录
V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
V2EX 提问指南
拉勾
V2EX  ›  问与答

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

  •  
  •   zhazi · 258 天前用 Android 发布 · 1518 次点击
    这是一个创建于 258 天前的主题,其中的信息可能已经有所发展或是发生改变。

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

    10 回复  |  直到 2018-09-30 00:30:58 +08:00
        1
    msg7086   258 天前
    所以你到底是要好的接口文档工具还是要把注释塞进 JSON 里玩呢。
        2
    yunye   258 天前 via Android
    Json 里加注释 大概是没吃饱
        3
    freestyle   258 天前 via iPhone
    这就是为什么 json 这么通用却没有流行作为配置文件格式
        4
    geelaw   258 天前
    一个可能的方式是宽松化你的 schema。

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

    http://json-schema.org/

    可以了解下合不合适
        10
    shsf4   171 天前
    json5
    关于   ·   FAQ   ·   API   ·   我们的愿景   ·   广告投放   ·   感谢   ·   实用小工具   ·   4002 人在线   最高记录 4385   ·  
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.3 · 16ms · UTC 03:05 · PVG 11:05 · LAX 20:05 · JFK 23:05
    ♥ Do have faith in what you're doing.
    沪ICP备16043287号-1