Golds全称Go local docs server。顾名思义,这是一款Go本地文档服务器,可以认为是官方godoc程序的一款竟品。相对于godoc,它有以下特点:
- 展示类型实现关系。这个对阅读和理解代码很有帮助。
- 展示所有的因为内嵌而得到的提升字段。这个对于阅读使用大量内嵌字段的项目很有用,比如kubernetes项目。
- 支持展示非导出资源。这对阅读理解其他人写的代码很有帮助。
- 丰富的代码阅读体验(点击局部标识符高亮显示此标识符的所有使用;点击引入路径高亮显示被引入包的所有使用;点击包级标识符直接跳转到声明处)。在浏览器里阅读代码的体验有时比在IDE里更好。
- 生成代码统计报告。支持生成静态HTML文档。
- JavaScript关闭不影响阅读体验;JavaScript打开体验更佳。
关于更多细小的特性,请阅读项目首页(https://github.com/go101/golds)。
截图示例: 统计信息实现关系
代码高亮
安装Golds很简单:
- 如果你已经在使用官方工具链1.16+版本,则可运行
go install http://go101.org/golds@latest
安装Golds; - 如果你仍在在使用官方工具链1.15-版本,则可运行
go get -u http://go101.org/golds
安装Golds。
安装后,可以
- 运行
golds ./...
来查看当前项目的文档和代码; - 运行
golds toolchain
来查看官方工具链的文档和代码;运行golds std来查看标准库的文档和代码; - 运行
golds ./... std
来查看当前项目和标准库的文档和代码; - 运行
golds toolchain std
来查看官方工具链和标准库的文档和代码。
生成的标准库文档展示:https://docs.go101.org/std/index.html
网友评论