我們用go語言編程時(shí)常常需要引用第三方包,通常我們習(xí)慣于用 godoc.org
或者官方網(wǎng)站看文檔絮供,或者到github
找第三方包的README文檔或者源代碼陶舞、sample代碼,但是一些名氣不大的第三方包一般不會被 godoc.org 收錄蜘犁,找官方文檔当编、看sample代碼往往耗費(fèi)大量時(shí)間。
gowalker.org
可以完美解決這個(gè)痛點(diǎn),它是一個(gè)實(shí)時(shí)生成第三方包說明文檔的網(wǎng)站礁扮。它的界面及其簡潔,功能非常實(shí)用瞬沦。這個(gè)網(wǎng)站簡直是go程序員的福音太伊,非常感謝它的開發(fā)者“無聞 Unknown” https://github.com/Unknwon !
下面介紹一下怎么操作它逛钻,首先看看主頁截圖:
既支持精確搜索(搜索框可以填入完整的第三方包路徑)僚焦,也可以只填入第三方包的名字進(jìn)行模糊搜索。當(dāng)你搜索成功后曙痘,如果它已經(jīng)存儲了該第三方包的說明文檔芳悲,那么它會顯示緩存好的說明文檔立肘;如果它還沒有該第三方包的文檔,它就會自動訪問源代碼托管網(wǎng)站名扛,實(shí)時(shí)生成該第三方包的文檔赛不。它支持國外的github.com
和國內(nèi)的gitee.com
等代碼托管平臺。
下面用我自己托管在gitee.com
上的第三方包演示一下(包 名是gitee.com/rocket049/connpool
):
如果搜索到的第三方包說明文檔太老了罢洲,不符合目前的版本踢故,可以點(diǎn)擊頁面下方的“刷新文檔”,它會馬上重新生成新的說明文檔惹苗。