Golds全稱Go local docs server。顧名思義扒怖,這是一款Go本地文檔服務(wù)器较锡,可以認(rèn)為是官方godoc程序的一款竟品。相對于godoc盗痒,它有以下特點:
- 展示類型實現(xiàn)關(guān)系蚂蕴。這個對閱讀和理解代碼很有幫助。
- 展示所有的因為內(nèi)嵌而得到的提升字段俯邓。這個對于閱讀使用大量內(nèi)嵌字段的項目很有用骡楼,比如kubernetes項目。
- 支持展示非導(dǎo)出資源稽鞭。這對閱讀理解其他人寫的代碼很有幫助君编。
- 豐富的代碼閱讀體驗(點擊局部標(biāo)識符高亮顯示此標(biāo)識符的所有使用;點擊引入路徑高亮顯示被引入包的所有使用川慌;點擊包級標(biāo)識符直接跳轉(zhuǎn)到聲明處)吃嘿。在瀏覽器里閱讀代碼的體驗有時比在IDE里更好祠乃。
- 生成代碼統(tǒng)計報告。支持生成靜態(tài)HTML文檔兑燥。
- JavaScript關(guān)閉不影響閱讀體驗亮瓷;JavaScript打開體驗更佳。
關(guān)于更多細小的特性降瞳,請閱讀項目首頁(https://github.com/go101/golds)嘱支。
截圖示例:統(tǒng)計信息
實現(xiàn)關(guān)系
代碼高亮
安裝Golds很簡單:
- 如果你已經(jīng)在使用官方工具鏈1.16+版本,則可運行
go install http://go101.org/golds@latest
安裝Golds挣饥; - 如果你仍在在使用官方工具鏈1.15-版本除师,則可運行
go get -u http://go101.org/golds
安裝Golds。
安裝后扔枫,可以
- 運行
golds ./...
來查看當(dāng)前項目的文檔和代碼汛聚; - 運行
golds toolchain
來查看官方工具鏈的文檔和代碼;運行g(shù)olds std來查看標(biāo)準(zhǔn)庫的文檔和代碼短荐; - 運行
golds ./... std
來查看當(dāng)前項目和標(biāo)準(zhǔn)庫的文檔和代碼倚舀; - 運行
golds toolchain std
來查看官方工具鏈和標(biāo)準(zhǔn)庫的文檔和代碼。
生成的標(biāo)準(zhǔn)庫文檔展示:https://docs.go101.org/std/index.html