如何查看特定 go 函数的文档？

Question

我正在寻找一种方便的方法来快速查找 Go 中不同功能和/或包的文档。我目前的方法是 google for say ioutil.ReadFile，但这很慢/不方便。理想的解决方案将直接在 vim 中工作，或者在 Go 解释器中工作（建议？）。例如，在 Python 中，可以通过将鼠标悬停在函数上或使用带有 egos.open?或的 ipython 解释器在 PyDev 中显示函数的文档help(os.open)。您如何查看 Go 的特定文档？

Answer 1

我使用godoc，这是一个适用于 Vim 和 Sublime 的自动完成守护程序。godoc 与GoSublime插件集成。godoc 的好处是它为所有包提供了自动完成功能。除了自动完成之外，我还可以按下super-., super-HSublime，它会提供我输入的函数的文档。

我还使用Dash进行快速记录。我使用DashDoc从 Sublime 快速查找 Dash 中的内容。还有dash.vim提供了一个从 Vim 到 Dash 的插件。

Dash 只提供内置包的文档，但我主要将它用于其他东西的离线文档。到目前为止，这是调出我发现的 HTML 格式文档的最快方法。

Answer 2

在 Vim 中（假设你已经安装了Go 的插件），输入:Godoc <something>，你将在不离开编辑器的情况下获得文档。您显然可以将一个键映射到这个（没有参数，如果我没记错的话，它会在光标位置搜索令牌）。

话虽如此，我也经常在 Vim 中使用Rob Pike 来doc代替 ( :!doc <something>)。