建站
咨詢
售后
建站咨詢
新聞中心
本文轉(zhuǎn)載自微信公眾號(hào)「碼農(nóng)桃花源」，作者qcrao。轉(zhuǎn)載本文請(qǐng)聯(lián)系碼農(nóng)桃花源公眾號(hào)。
某天寫(xiě)代碼時(shí)發(fā)現(xiàn)自己對(duì) IDE 的依賴非常深，如果沒(méi)了 Goland 就不會(huì)寫(xiě)代碼了，心里為之一驚。
Goland 的自動(dòng)補(bǔ)全功能已經(jīng)是必需品了，只要打出相關(guān)的幾個(gè)字符，不管是變量名還是函數(shù)調(diào)用，都能幫你直接補(bǔ)全。我們只需要往相應(yīng)的位置填東西就行了。
進(jìn)而又想到，當(dāng)補(bǔ)全功能缺失或者暫時(shí)失靈的情況下，該如何快速地查出某個(gè)函數(shù)的具體用法呢?
假設(shè)我們想要對(duì)字符串做 split，卻忘了具體用法，下面是幾種常見(jiàn)的查文檔方法。
在設(shè)置了語(yǔ)言是 english 的情況下，還是挺精準(zhǔn)的。直接定位到 Go 官方文檔。
Dash
Dash
同樣很準(zhǔn)確，搜索詞不需要很精準(zhǔn)。
devdocs.io[1]
devdocs
這個(gè)也不錯(cuò)，而且支持很多種語(yǔ)言。
pkg.go.dev
pkg.go.dev
優(yōu)點(diǎn)是官方文檔，最權(quán)威，逼格最高。缺點(diǎn)是要準(zhǔn)確地記住包名+函數(shù)名。
go doc
cmd
優(yōu)點(diǎn)是直接 iTerm2 里就可以查看，缺點(diǎn)是需要準(zhǔn)確地記住包名+函數(shù)名。
有些大佬用 vim 寫(xiě)代碼，在 shell 環(huán)境里直接能查文檔，還是很有用的。不過(guò)對(duì)我等用 Goland 的菜雞用處不大。
上面這幾種方法我用得最多的還是 Google，可能這并不是最快的方式，但是它總是能幫你找到所有有用的信息。沒(méi)有 Google，我可能也不會(huì)寫(xiě)代碼了。
最近看到一篇文章[2]，就講了如何利用 Go 標(biāo)準(zhǔn)庫(kù)做出一個(gè)好用的查文檔工具。
原理是利用 Go 提供的包解析工具，把所有的導(dǎo)出類型列出來(lái)。然后在我們搜索的時(shí)候用模糊匹配的方式找到符合的類型，再用這個(gè)精確的類型調(diào)用 go doc。
流程如下：
gdoc 原理
在 Linux 下結(jié)合 dmenu，使用非常順滑：
gdoc-cmd
偷個(gè)懶，直接用原文的動(dòng)圖。??
當(dāng)然，不嫌棄瀏覽器的情況下，還提供了一個(gè)可視化的界面，同樣有模糊匹配的功能且可以一鍵直達(dá) pkg.go.dev 對(duì)應(yīng)的頁(yè)面。比 google 可能快一點(diǎn)。
gdoc-web
選中其中一個(gè)，會(huì)直接跳轉(zhuǎn)過(guò)來(lái)：
跳轉(zhuǎn)到 pkg.go.dev
后記
不過(guò)，即使知道了這些方法，可能最后還是會(huì)退化到用 Google 直接搜，因?yàn)樯抖疾恍枰洠械臇|西都可以用 Google 搜索出來(lái)。
這也是最方便的方法，什么額外的事情都不用做。因?yàn)榉奖?，成本低，自然就想把所有的事情都挪到它上面?lái)做，即使有很多專業(yè)的查文檔工具的情況下，還是會(huì)這么做。
一件事，如果容易，那就會(huì)經(jīng)常做。反之，如果成本比較高，結(jié)果不是做這件事花的時(shí)間更多，而是我們選擇不去做它。
不知道你平時(shí)查文檔時(shí)用的什么方法，歡迎留言一起討論。
參考資料
[1]devdocs.io: https://devdocs.io/
[2]文章: https://eli.thegreenplace.net/2018/command-line-autocomplete-for-go-documentation/
網(wǎng)站名稱：寫(xiě) Go 時(shí)如何優(yōu)雅地查文檔
轉(zhuǎn)載來(lái)于：http://m.5511xx.com/article/cosggjj.html
