ブログ

You are currently viewing GoDocを試してみる

GoDocを試してみる

現実逃避でGo言語でアプリを作り始めました。
コメントを残すならGoDoc形式のコメントを書いておきたかったので、GoDocを利用する方法を調べてみました。

参考にさせて頂いた記事はこちら
https://zenn.dev/mkosakana/articles/bb411e9d6b5ad9

検証環境

・MacBookPro 2019 IntelCPU
・Go 1.19

GoDocのインストール

GoをインストールしただけではGoDocはインストールされないみたいなので、以下の手順で利用できるようにします

まずはパッケージをインストールします

go install golang.org/x/tools/cmd/godoc@latest

インストールしただけでは「zsh: command not found: godoc」のエラーが出てしまうため、パスを設定します

vi ~/.zshrc

以下を追加して保存
export GOPATH=$(go env GOPATH)
export PATH=$PATH:$GOPATH/bin

保存後、sourceコマンドで有効化
source ~/.zshrc

パスを通したあとは、godocコマンドが利用できるはずなので、以下のコマンドで起動します

godoc

ターミナルが以下の用になれば、起動しています(生成されたドキュメントはブラウザから確認するようです)

あとは以下のURLにアクセスすれば、GoDocが確認できるはずです
http://localhost:6060/

ちょっとだけ見てみる

自分が作成したパッケージもきちんとGoDocかされていました。

こんな感じで、関数の直前に記載したコメントもドキュメント内に反映されていました

まとめ

別途インストールが必要だったり、パスを通す必要があったりと初期セットアップは若干の手間を感じました。
ただ、生成されるドキュメントは使いやすそうなので、有効活用していきたいですね

実用 Go言語 システム開発の現場で知っておきたいアドバイス [ 渋川 よしき ]
created by Rinker
¥3,960 (2024/10/27 17:14:51時点 楽天市場調べ-詳細)
エキスパートたちのGo言語　一流のコードから応用力を学ぶ [ 上田 拓也 ]
created by Rinker
¥3,278 (2024/10/27 14:11:47時点 楽天市場調べ-詳細)

コメントを残す