/godocExample

Primary LanguageGoBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

golang 如何写注解文档

Go Reference License

作为 Gopher，你知道 Go 的注释即文档应该怎么写吗？
万字长文解读 pkg.go.dev 的设计和实现

命令

$ go install golang.org/x/tools/cmd/godoc
$ godoc

默认端口：6060

cd XXXX; godoc -http=:6060

其中 XXXX 是包含 go.mod 的一个仓库目录。假设 XXX 是我的 jsonvalue 库的本地目录，根据 go.mod，这个库的地址是 github.com/Andrew-M-C/go.jsonvalue。
那么我就可以在浏览器中打开 http://${IP}:${PORT}/pkg/github.com/Andrew-M-C/go.jsonvalue/，就可以访问我的 jsonvalue 库的 GoDoc 页面了。
并且可以访问 go.mod 中所有库的 godoc。

在官网上发布 GoDoc

  • 需要打 tag
  • 需要 License 文件