Golang 見證 godoc 的強大（生成API文檔，打印文檔）

文章目錄

• Golang 見證 godoc 的強大（生成API文檔，打印文檔）
• • 一、godoc 介紹
  • 二、godoc 安裝
  • • ① 系統(tǒng)環(huán)境
    • ② 下載安裝
  • 三、godoc 使用
  • 四、godoc 的其他功能

本次我們使用的是 godoc 來生成 API 文檔

一、godoc 介紹

• 在辛苦寫完一個項目后，你是否苦惱于不知怎么給用戶解釋它的功能，又或者是覺得一一解釋太過繁瑣？不怕，接下來筆者要介紹的 godoc 就是一項有力的自動生成 API 工具，既方便了讀者，又幫助了開發(fā)者
• godoc 是 Go 語言中一個可以自動生成 API 文檔的第三方庫
  
  

二、godoc 安裝

① 系統(tǒng)環(huán)境

• 操作系統(tǒng)：CentOS Linux release 7.9.2009
• 代碼編輯器：visual studio code
• 編譯工具：go version go1.13.1 linux/amd64

② 下載安裝

git clone https://github.com/golang/tools $GOPATH/src/golang.org/x/tools go build golang.org/x/tools

• 然后在命令行中就可以正常執(zhí)行 godoc 命令
• 或者也可以直接使用指令 go get -v golang.org/x/tools/cmd/godoc 一步到位

三、godoc 使用

下文將以筆者開發(fā)的 json_Marshal 項目為例，演示如何用 godoc 生成 API 文檔

• 首先注釋項目 iniReader main.go 文件的 main 函數(shù)，將 package 改為iniReader，然后執(zhí)行如下指令:

go install // 生成 API 文檔 godoc // 下載保存 API 文檔 godoc -url="pkg/jsonmarshal/jsonmarshal" > API.html

便會在當(dāng)前目錄下生成 API.html 文件:

API 文檔，用瀏覽器打開后界面如下

• 可以保存為 PDF 文件
• 或者也可以通過網(wǎng)絡(luò)瀏覽器的地址欄中輸入 http://localhost:8080/pkg/jsonmarshal/jsonmarshal 來查看以網(wǎng)頁方式展現(xiàn)的 API 文檔
  
  

四、godoc 的其他功能

• godoc 還有另一種功能就是打印純文本格式的文檔到標(biāo)準(zhǔn)輸出
• 比如我們用命令行模式查看代碼包 log 的文檔，如下圖，包括了 log 的介紹，和所有函數(shù)

go doc log

• 如果我們想查看某一個函數(shù)或結(jié)構(gòu)體的文檔，可以將這個函數(shù)或結(jié)構(gòu)體的名稱加入命令的后面，即

go doc log Fatal

• 或者

go doc log Logger

• 此外，還可以通過添加 -src 查看它們的源碼

go doc -src log Fatal

以上就是 godoc 強大之處的介紹

總結(jié)

以上是生活随笔為你收集整理的Golang 见证 godoc 的强大（生成API文档，打印文档）的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。