godoc使用教程

注釋規范

• 注釋符//后面要加空格, 例如: // xxx

  在注釋符要縮進的話，第二行注釋符后面的空格要比上一行的空格多一個example:// 123// 123

• 注釋要緊跟package、const、type、func這些關鍵字，這樣子才會被顯示

  // 功能: 函數H的注釋// 參 數:// h1 : 說明參數值// h2 : 運算的數字// 返回值:// reValue : 返回值//你會發現函數H的功能注釋沒有顯示，這是因為功能函數注釋與關鍵字func之間空了一行func H(h1 string, h2 string) (reValue string) {fmt.Println(h1, h2)return h1}

• package的注釋最好不好超過3行，不過就算超過3行也沒有關系。這里只是做一個規范而已。如果對于pkg描述的注釋有很多行的時候，我們可以新建一個doc.go，這個文件用于對package包的描述

• 同一目錄下的包可以由很多個文件組成，如果每個文件都有對package進行注釋的話，godoc會自動將所有注釋"按照文件名的字母數序"進行合并

  詳細等會看實例文件

• 在無效注釋中以BUG(who)開頭的注釋, 將被識別為已知bug, 顯示在bugs區域

  // BUG(who): 因為前面有BUG(who)這個關鍵字，所以這句注釋就算沒有緊跟關鍵字不會被隱藏掉

在終端查看

在終端，進入要查看的包的目錄go doc顯示當前包的文檔
這里查看的是包名的文檔，以及所有的函數名字跟變量類型名

example:go docterminal show:package test // import "test/testdoc"這個是a.go的包名的描述At 20191017 by Baiyu---a.go end---這個是在doc.go 文件中的內容在Go的源代碼中在Mac系統中在類Unix系統中在Windows系統中---doc.go end---這個是在testgodoc.go文件的內容 package Name: testdescribe: 程序的入口---testgodoc.go end---這個是z.go 的包名描述---z.go end---const Email ...const Baiyu = "baiyu"func H(h1 string, h2 string) (reValue string)func Test(param1 string, inter int) (k string)func Z()type Computer struct{ ... }type Person struct{ ... }BUG: 這個注釋會生成在文檔最后后面，同時因為緊跟著fun Z，所以在上面的func列表里面也有顯示功能: 生成Z簽名BUG: 因為前面有BUG(who)這個關鍵字，所以這句注釋就算沒有緊跟關鍵字不會被隱藏掉BUG: BUG(6):格式正確，所以這句注釋就算沒有緊跟關鍵字不會被隱藏掉，前面的BUG():、BUG6:、BUG:都是不正確的BUG(who)命名

go doc <pkg>.<func>查看pkg包下面的func函數的注釋

example:go doc test.Testterminal show:package test // import "test/testdoc"func Test(param1 string, inter int) (k string)功能: 測試函數參 數:param1 : 說明參數值inter : 運算的數字返回值:k : 返回值

如果想查看完整的源碼go doc -src <pkg>.<func>

example: go doc -src test.Test terminal show:package test // import "test/testdoc"// 功能: 測試函數// 參 數:// param1 : 說明參數值// inter : 運算的數字// 返回值:// k : 返回值func Test(param1 string, inter int) (k string) {fmt.Println("測試函數")return param1}

在瀏覽器上查看

使用命令godoc -http=:6060
然后在打開瀏覽器的，在url輸入localhost:6060/pkg或者127.0.0.1:6060/pkg就可以查看到你本地的所有包的信息了

如果你想要找到你特定的包名的話localhost:6060/pkg/<path>/<packageName>或者127.0.0.1:6060/pkg/<path>/<packageName>

<path>是你/src下包所在的路徑

<packageName>是包名

導出godoc文檔為HTML

使用命令godoc -url "http://localhost:6060/pkg/<pkg>/<packageName>/" > <packageName>.html

<pkg>是你包所在的文件夾

<packageName>是你的包名

導出來的是純html文件，沒有樣式表，不過也有可能可以導出，但是我目前沒有找到，如果有找到的朋友也可以交流一下

不過我也有把對應的樣式文件給導出來了

下載地址https://github.com/BaiYu96/golandLearn/tree/master/learn_doc/stylefile

然后把html文件里面的css跟js指定的路徑修改好就可以

教程示例文件

下載地址https://github.com/BaiYu96/golandLearn/tree/master/learn_doc/test

把test文件夾放到你$GOPATH/src/目錄下

總結

以上是生活随笔為你收集整理的go语言学习笔记——godoc的使用（超详细，含示例文件）的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。