我们用go语言编程时常常需要引用第三方包,通常我们习惯于用 godoc.org
或者官方网站看文档,或者到github
找第三方包的README文档或者源代码、sample代码,但是一些名气不大的第三方包一般不会被 godoc.org 收录,找官方文档、看sample代码往往耗费大量时间。
gowalker.org
可以完美解决这个痛点,它是一个实时生成第三方包说明文档的网站。它的界面及其简洁,功能非常实用。这个网站简直是go程序员的福音,非常感谢它的开发者“无闻 Unknown” https://github.com/Unknwon !
下面介绍一下怎么操作它,首先看看主页截图:
既支持精确搜索(搜索框可以填入完整的第三方包路径),也可以只填入第三方包的名字进行模糊搜索。当你搜索成功后,如果它已经存储了该第三方包的说明文档,那么它会显示缓存好的说明文档;如果它还没有该第三方包的文档,它就会自动访问源代码托管网站,实时生成该第三方包的文档。它支持国外的github.com
和国内的gitee.com
等代码托管平台。
下面用我自己托管在gitee.com
上的第三方包演示一下(包 名是gitee.com/rocket049/connpool
):
如果搜索到的第三方包说明文档太老了,不符合目前的版本,可以点击页面下方的“刷新文档”,它会马上重新生成新的说明文档。