前言
最近在用go语言做项目,语法还是很简单的,但是API不熟悉,😅,另外也没有类似Java的Spring这样的独秀的IOC和AOP框架,灵活度很大,经常需要查询文档,但是godoc从go1.14.2开始就从内置SDK移除了。
gomod安装godoc
安装很容易
go get -v golang.org/x/tools/cmd/godoc
但是只能在gomod中使用
笔者随意创建一个项目go mod init xxx,然后在项目根目录,执行上面的指令,会下载一堆包到gopath下
然后执行
go install golang.org/x/tools/cmd/godoc
安装,结束后会在gopath下生成bin目录,原来的依赖是pkg目录,类似maven的本地仓库
bin目录下就是godoc可执行文件
godoc主要能力
核心能力就是暴露http服务,浏览器直接访问,可查询API,还有示例
浏览器访问localhost:6060
如果仅仅是看某个API,可以直接用go doc,只是要敲很多命令
其他方式
还可以其他方式,比如在线文档Go Packages
如果是macOS还可以使用Dash软件,集成了很多API,直接下载就可以使用
当然最好的方式是知道package的名称,依赖进工程,直接通过包名找到源代码,看源码知道api的用途
总结
实际上godoc是一个很方便的文档查询工具,不知道为什么go sdk移除掉了,但是可以通过手动安装的方式安装,实现本地文档查看