写 Go 时如何优雅地查文档

2021-09-28 15:04:18 浏览数 (1)

某天写代码时发现自己对 IDE 的依赖非常深,如果没了 Goland 就不会写代码了,心里为之一惊。

Goland 的自动补全功能已经是必需品了,只要打出相关的几个字符,不管是变量名还是函数调用,都能帮你直接补全。我们只需要往相应的位置填东西就行了。

进而又想到,当补全功能缺失或者暂时失灵的情况下,该如何快速地查出某个函数的具体用法呢?

假设我们想要对字符串做 split,却忘了具体用法,下面是几种常见的查文档方法。

Google

google

在设置了语言是 english 的情况下,还是挺精准的。直接定位到 Go 官方文档。

Dash

Dash

同样很准确,搜索词不需要很精准。

devdocs.io[1]

devdocs

这个也不错,而且支持很多种语言。

pkg.go.dev

pkg.go.dev

优点是官方文档,最权威,逼格最高。缺点是要准确地记住包名 函数名。

go doc

cmd

优点是直接 iTerm2 里就可以查看,缺点是需要准确地记住包名 函数名。

有些大佬用 vim 写代码,在 shell 环境里直接能查文档,还是很有用的。不过对我等用 Goland 的菜鸡用处不大。

0 人点赞