V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
hheedat
V2EX  ›  程序员

如何正确的使用 API 文档?

  •  
  •   hheedat · 2023-10-12 17:41:54 +08:00 · 920 次点击
    这是一个创建于 406 天前的主题,其中的信息可能已经有所发展或是发生改变。

    一直有个疑惑,很多库的 API 文档(不只限于 golang 一种语言),写的很难看懂。

    方法列的挺全,点进去几乎没有解释和用法的例子。得结合库的其他整体信息,库里的其他方法,代码的结构,网上搜例子或者问 GPT 等,综合推理方法的正确用法。

    举例,我想知道 term query 有多个条件 a = 1 && b = 2 && c = 3 如何组合使用,看文档愣是没看懂,搜了个例子才知道😭

    https://pkg.go.dev/github.com/olivere/elastic#TermQuery

    是文档的问题还是我的问题?

    cxtrinityy
        1
    cxtrinityy  
       2023-10-12 17:52:46 +08:00 via Android
    你的问题,下面不是写了 for detail, see http://xxx.. 么
    hheedat
        2
    hheedat  
    OP
       2023-10-13 13:36:35 +08:00
    @cxtrinityy see 的是 ES DSL 的原始用法,不是如何通过 SDK 能达成这种 DSL 的效果呀
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   3062 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 25ms · UTC 13:38 · PVG 21:38 · LAX 05:38 · JFK 08:38
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.