写 Go 时怎样优雅地查文档
发布时间：2021-11-06 13:57:16 所属栏目：语言 来源：互联网
导读：某天写代码时发现自己对 IDE 的依赖非常深，如果没了 Goland 就不会写代码了，心里为之一惊。 Goland 的自动补全功能已经是必需品了，只要打出相关的几个字符，不管是变量名还是函数调用，都能帮你直接补全。我们只需要往相应的位置填东西就行了。 进而又想到
|
某天写代码时发现自己对 IDE 的依赖非常深，如果没了 Goland 就不会写代码了，心里为之一惊。 Goland 的自动补全功能已经是必需品了，只要打出相关的几个字符，不管是变量名还是函数调用，都能帮你直接补全。我们只需要往相应的位置填东西就行了。 进而又想到，当补全功能缺失或者暂时失灵的情况下，该如何快速地查出某个函数的具体用法呢? 假设我们想要对字符串做 split，却忘了具体用法，下面是几种常见的查文档方法。 在设置了语言是 english 的情况下，还是挺精准的。直接定位到 Go 官方文档。 Dash Dash 同样很准确，搜索词不需要很精准。 devdocs.io[1] devdocs 这个也不错，而且支持很多种语言。 pkg.go.dev pkg.go.dev 优点是官方文档，最权威，逼格最高。缺点是要准确地记住包名+函数名。 go doc cmd 优点是直接 iTerm2 里就可以查看，缺点是需要准确地记住包名+函数名。 有些大佬用 vim 写代码，在 shell 环境里直接能查文档，还是很有用的。不过对我等用 Goland 的菜鸡用处不大。 上面这几种方法我用得最多的还是 Google，可能这并不是最快的方式，但是它总是能帮你找到所有有用的信息。没有 Google，我可能也不会写代码了。 最近看到一篇文章[2]，就讲了如何利用 Go 标准库做出一个好用的查文档工具。 原理是利用 Go 提供的包解析工具，把所有的导出类型列出来。然后在我们搜索的时候用模糊匹配的方式找到符合的类型，再用这个精确的类型调用 go doc。 流程如下： gdoc 原理 在 Linux 下结合 dmenu，使用非常顺滑： gdoc-cmd 偷个懒，直接用原文的动图。?? 当然，不嫌弃浏览器的情况下，还提供了一个可视化的界面，同样有模糊匹配的功能且可以一键直达 pkg.go.dev 对应的页面。比 google 可能快一点。 （编辑：好传媒网） 【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容! |
