TOC

godoc 命令

godoc -http=:6060 -index -play -timestamps -v

# 如果在 go 模块目录执行,会列出本地依赖包的文档
# using module mode; GOMOD=xxx.mod

go doc fmt
go doc fmt.Println
go doc fmt Println
go doc -src fmt Println

# 查看本地包文档
go doc github.com/astaxie/beego
go doc github.com/astaxie/beego Listen
go doc -all github.com/astaxie/bee

PS: 关于 Go 项目文档

  1. 紧挨者 package, const, type, func 等关键字的注释

问题

C:\Users\admin>godoc -http=:6060 -index -play -timestamps -v
'godoc' 不是内部或外部命令,也不是可运行的程序
或批处理文件。

新版本不再自带 godoc 工具,需要另外安装:

go install golang.org/x/tools/cmd/godoc@latest