godoc

该命令可以生成一个Go官方文档的本地http服务,可以在线查看标准库和第三方库文档,以及项目文档,但是需要按照一定的格式去写注释。

// 安装godoc
go get -v  golang.org/x/tools/cmd/godoc

// 方式一
godoc -http=:6060

// 方式二 :-play可以使用playground运行Example代码
godoc -http=:6060 -play

// 查看自己的项目文档,需要将其它路径下的项目代码目录建一个软链到GOROOT的src目录下,如cd $GOROOT/src; ln -s /data/my-project ./,在浏览器后面输入项目名即可
http://127.0.0.1:6060/pkg/my-project/

Web页面如下:

最后编辑: kuteng  文档更新时间: 2022-07-29 14:34   作者:kuteng