如何正确的使用 API 文档?

212 天前
 hheedat

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

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

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

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

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

748 次点击
所在节点    程序员
2 条回复
cxtrinityy
212 天前
你的问题,下面不是写了 for detail, see http://xxx.. 么
hheedat
211 天前
@cxtrinityy see 的是 ES DSL 的原始用法,不是如何通过 SDK 能达成这种 DSL 的效果呀

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

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

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

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

© 2021 V2EX