LoginSignup
11

More than 1 year has passed since last update.

Go(ver1.16.2) でgodocを使えるようにするための手順

Last updated at Posted at 2021-03-23

godocとは?

Go言語は、godoc というコマンドがあります。このコマンドのおかげでgolang.orgのパッケージのドキュメントをオフラインで閲覧することが出来ます。

前提条件

環境

  • OS : macOS Big Sur バージョン11.2.1

  • Go : 1.16.2 darwin/amd64

状態

Goをインストールしたときに、一緒にインストールされるはずのgodocコマンドが使えない。

やりたいこと

godocを使って、オフラインでドキュメントを閲覧したい。またWebサーバーとして起動して、ブラウザ上で確認したい。

手順

go get コマンドでgodocコマンドをインストールします。

$ go get golang.org/x/tools/cmd/godoc

$GOROOT/binのパスを通す。

$ export GOPATH=$HOME/go
$ export PATH=$PATH:$GOROOT/bin:$GOPATH/bin

以下引用

GOROOT/binをPATH環境変数に追加しているのは、godocのコマンドのインストール先がここになるから。(通常は、GOPATH/binにインストールされるらしい)

これでgodocコマンドが使えるようになりました。

http://localhost:3000/ にアクセスして、確認してみましょう!!!

godoc -http ":3000"

スクリーンショット 2021-03-23 14.00.49.png

オフラインで閲覧することが出来ました!!!(わーい)

まとめ

今回は、Goをインストールすると一緒にインストールされるはずのgodocコマンドが、ver1.16.2ではインストールされていませんでした。
そこで下記の手順を踏まえて、godocコマンド使える状態にしました。

  1. go getでgodocコマンドをインストール
  2. $GOROOT/binのパスを通す(godocのコマンドのインストール先がGOPATH/binではなく、GOROOT/binであることを踏まえる)

以上です。
最後まで読んでいただき、ありがとうございます!

参考リンク

https://ascii.jp/elem/000/001/243/1243667/
https://qiita.com/megu_ma/items/2066aef2f8c7f0ce2cc3

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
11