写 Go 时如何优雅地查文档
source link: https://qcrao.com/2021/09/09/look-up-go-doc-gracefully/
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
写 Go 时如何优雅地查文档
某天写代码时发现自己对 IDE 的依赖非常深，如果没了 Goland 就不会写代码了，心里为之一惊。
Goland 的自动补全功能已经是必需品了，只要打出相关的几个字符，不管是变量名还是函数调用，都能帮你直接补全。我们只需要往相应的位置填东西就行了。
进而又想到，当补全功能缺失或者暂时失灵的情况下，该如何快速地查出某个函数的具体用法呢？
假设我们想要对字符串做 split，却忘了具体用法，下面是几种常见的查文档方法。
在设置了语言是 english 的情况下，还是挺精准的。直接定位到 Go 官方文档。
同样很准确，搜索词不需要很精准。
devdocs.io
devdocs
这个也不错，而且支持很多种语言。
pkg.go.dev
pkg.go.dev
优点是官方文档，最权威，逼格最高。缺点是要准确地记住包名+函数名。
go doc
优点是直接 iTerm2 里就可以查看，缺点是需要准确地记住包名+函数名。
有些大佬用 vim 写代码，在 shell 环境里直接能查文档，还是很有用的。不过对我等用 Goland 的菜鸡用处不大。😂
上面这几种方法我用得最多的还是 Google，可能这并不是最快的方式，但是它总是能帮你找到所有有用的信息。没有 Google，我可能也不会写代码了。
最近看到一篇文章，就讲了如何利用 Go 标准库做出一个好用的查文档工具。
原理是利用 Go 提供的包解析工具，把所有的导出类型列出来。然后在我们搜索的时候用模糊匹配的方式找到符合的类型，再用这个精确的类型调用 go doc。
流程如下：
gdoc 原理
在 Linux 下结合 dmenu，使用非常顺滑：
gdoc-cmd
偷个懒，直接用原文的动图。😀
当然，不嫌弃浏览器的情况下，还提供了一个可视化的界面，同样有模糊匹配的功能且可以一键直达 pkg.go.dev 对应的页面。比 google 可能快一点。
gdoc-web
选中其中一个，会直接跳转过来：
跳转到 pkg.go.dev
不过，即使知道了这些方法，可能最后还是会退化到用 Google 直接搜，因为啥都不需要记，所有的东西都可以用 Google 搜索出来。
这也是最方便的方法，什么额外的事情都不用做。因为方便，成本低，自然就想把所有的事情都挪到它上面来做，即使有很多专业的查文档工具的情况下，还是会这么做。
一件事，如果容易，那就会经常做。反之，如果成本比较高，结果不是做这件事花的时间更多，而是我们选择不去做它。
不知道你平时查文档时用的什么方法，欢迎留言一起讨论。
- 本文作者：饶全成
- 本文链接：https://qcrao.com/2021/09/09/look-up-go-doc-gracefully/
- 版权声明：本文章著作权归作者所有，任何形式的转载都请注明出处。
Related Issues not found
Please contact @qcrao to initialize the comment
Recommend
About Joyk
Aggregate valuable and interesting links.
Joyk means Joy of geeK