今天在学习如何用godoc生成api文档的时候出现了一个问题,运行一下指令时会出现错误:
// 本机:localhost:6060生成web服务器,其中是api文档
godoc -http=:6060
该指令是用于生成HTML的api文档,书上说,它与Go一起安装,但是当我运行时会出现:
godoc : 无法将“godoc”项识别为 cmdlet、函数、脚本文件或可运行程序的名称。请检查名称的拼写,如果包括路>>径,请确保路径正确
,然后再试一次。
所在位置 行:1 字符: 1
- godoc
- ~~~~ + CategoryInfo : ObjectNotFound: (gdfg:String) [], CommandNotFoundException
+ FullyQualifiedErrorId : CommandNotFoundException
查询后才发现在Golang version1.13之后,Golang核心包中就不再包含godoc。而我的版本是go version go1.18.1 windows/amd64
。
因此如果需要用到godoc,需要自己手动下载安装。
查询了网上很多方法,其中如何安装godoc - 编程语言 - 亿速云提供的方法,是网上最多的。
但是对于我来说又失败了,运行了之后没有生成任何文件。
然后再去试了试git clone的那种方法:go安装godoc - 摸鱼划水,这种方法其实应该是可以的,但是$GOPATH
路径一定要自己手动输入,系统不会替换成系统变量那一个,获取了那个包之后,执行go install ...
或者go build golang.org/x/tools
也不行(即使我指定了路径)。分析了一下原因,应该是国家保护的问题,会出现各种各样的网络错误。
最后的最后,有点气馁了,但是我想出了一个曲线救国的方法!
方法很简单:
1、首先我们去GitHub下载go/tools,下载下来一个压缩包,解压到你的$GOPATH/src
中
2、然后在src文件夹下面,打开cmd命令行,输入以下命令:go install golang.org/x/tools/...@latest
3、等待一会,会发现命令执行完成,去查看$GOPATH/bin
中的文件,发现多了很多的.exe
文件,这就是刚刚打包的go文件
4、此时运行godoc
命令,发现还是不行,此时我们就要手动把刚刚打包的go文件复制黏贴到安装Golang的目录下,也就是$GOROOT/bin
下。
5、此时打开cmd,执行命令:godoc
,出现了:using GOPATH mode
,安装成功!
最后贴一个Github上的Golang语言工具库下载链接:golang/tools