go godoc 文檔服務(wù)器

搭建公司內(nèi)部自己的 godoc 服務(wù)器

早期的go項目規(guī)范:

  • 必須在GOPATH下
  • 項目的包的命名路徑與git的路徑關(guān)聯(lián)

引入go modules之后,項目可以不在GOPATH內(nèi),包的命名也可以不包含git的路徑。

godoc 生成的文檔,只掃描GOPATH與GOROOT內(nèi)的代碼,在此之外的代碼無法生成在線文檔,詳見go-issue-26827

基于此歷史背景,一個較好的go項目規(guī)范如下:

  • 項目統(tǒng)一命名規(guī)范帶上git路徑,格式:module git.your-company.com/{business}/{your proj name}為了兼容歷史與 godoc 方便生成文檔。
  • go項目不強制放在GOPATH內(nèi)
  • 使用go modules時,module 的命名規(guī)范參照第一條
  • godoc 搭建文檔服務(wù)器時,go modules的項目使用軟鏈的形式鏈接到GOPATH內(nèi)

安裝與啟動

  • 安裝:go get golang.org/x/tools/cmd/godoc
  • 啟動:godoc -http=":3000"
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

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

  • 1. 分布式系統(tǒng)核心問題 參考書籍:《區(qū)塊鏈原理、設(shè)計與應(yīng)用》 一致性問題例子:兩個不同的電影院買同一種電影票,如...
    molscar閱讀 929評論 0 0
  • 一、Go的包設(shè)計理念 1.代碼盒子 在Go程序中,包是代碼模塊組織的單位,為項目代碼組織結(jié)構(gòu),提高代碼的可讀性、重...
    GoFuncChan閱讀 497評論 0 0
  • How to Write GO Code 中文版 說明官方原文本文按個人理解進行意譯,水平有限,難免有錯或偏差,歡...
    楠小忎閱讀 1,609評論 1 4
  • go build 這個命令主要用于編譯代碼。在包的編譯過程中,若有必要,會同時編譯與之相關(guān)聯(lián)的包。 如果是普通包,...
    今早上閱讀 633評論 0 3
  • 本規(guī)范旨在為日常Go項目開發(fā)提供一個代碼的規(guī)范指導(dǎo),方便團隊形成一個統(tǒng)一的代碼風(fēng)格,提高代碼的可讀性,規(guī)范性和統(tǒng)一...
    Shaw_Lee閱讀 1,117評論 0 1