可以替代godoc的Go文檔和代碼閱讀神器Golds

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

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末忍宋,一起剝皮案震驚了整個濱河市痕貌,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌糠排,老刑警劉巖舵稠,帶你破解...
    沈念sama閱讀 217,542評論 6 504
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異入宦,居然都是意外死亡柱查,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,822評論 3 394
  • 文/潘曉璐 我一進店門云石,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人研乒,你說我怎么就攤上這事汹忠。” “怎么了雹熬?”我有些...
    開封第一講書人閱讀 163,912評論 0 354
  • 文/不壞的土叔 我叫張陵宽菜,是天一觀的道長。 經(jīng)常有香客問我竿报,道長铅乡,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,449評論 1 293
  • 正文 為了忘掉前任烈菌,我火速辦了婚禮阵幸,結(jié)果婚禮上花履,老公的妹妹穿的比我還像新娘。我一直安慰自己挚赊,他們只是感情好诡壁,可當(dāng)我...
    茶點故事閱讀 67,500評論 6 392
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著荠割,像睡著了一般妹卿。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上蔑鹦,一...
    開封第一講書人閱讀 51,370評論 1 302
  • 那天夺克,我揣著相機與錄音,去河邊找鬼嚎朽。 笑死铺纽,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的火鼻。 我是一名探鬼主播饵婆,決...
    沈念sama閱讀 40,193評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼杭隙,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起偷卧,我...
    開封第一講書人閱讀 39,074評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎靡菇,沒想到半個月后便斥,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,505評論 1 314
  • 正文 獨居荒郊野嶺守林人離奇死亡鹏控,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,722評論 3 335
  • 正文 我和宋清朗相戀三年致扯,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片当辐。...
    茶點故事閱讀 39,841評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡抖僵,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出缘揪,到底是詐尸還是另有隱情耍群,我是刑警寧澤,帶...
    沈念sama閱讀 35,569評論 5 345
  • 正文 年R本政府宣布找筝,位于F島的核電站蹈垢,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏袖裕。R本人自食惡果不足惜曹抬,卻給世界環(huán)境...
    茶點故事閱讀 41,168評論 3 328
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望急鳄。 院中可真熱鬧谤民,春花似錦堰酿、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,783評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至兢榨,卻和暖如春嗅榕,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背吵聪。 一陣腳步聲響...
    開封第一講書人閱讀 32,918評論 1 269
  • 我被黑心中介騙來泰國打工凌那, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人吟逝。 一個月前我還...
    沈念sama閱讀 47,962評論 2 370
  • 正文 我出身青樓帽蝶,卻偏偏與公主長得像,于是被迫代替她去往敵國和親块攒。 傳聞我的和親對象是個殘疾皇子励稳,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 44,781評論 2 354

推薦閱讀更多精彩內(nèi)容