godocの代わりに`go doc`を推奨された件について

|
featured image

godocはGoの各プログラムのドキュメントをGUIとCLI上で展開してくれるパッケージだったのですが、使用してみたところ下記のようなメッセージが表示されました。

godoc -http=localhost:6060 fmt
 Unexpected arguments. Use "go doc" for command-line help output instead. For example, "go doc fmt.Printf".

godocのCLIモードはサポート終了

調べてみたところバージョン1.12からCLIのサポートは終了、代わりに go doc を使って欲しいと言及されていました。

I propose we delete x/tools/cmd/godoc’s CLI support and keep it being a web-only tool. Users who want CLI support can use “go doc”. Both are shipped with Go releases.

https://github.com/golang/go/issues/25443

godocのバリデーションが多く、ドキュメントの整理が大変なのが理由のようです。

そして最終的に、 godoc のCLIモードは1.11でサポート終了となりました。

Decision: we’ll document in the Go 1.11 release notes that the Go 1.11 release will be the last to support CLI mode godoc (no space). In Go 1.12, users (and any IDEs?) will need to use go doc for the CLI mode.

https://github.com/golang/go/issues/25443

まとめ

バージョン1.11がベースになっている参考書などは godoc になっている場合があるかも知れませんが、CLIでのサポートは終了したので、ターミナルでは go doc を使います。

GUIでのサポートは継続しているので、ブラウザなどでパッケージの詳細を調べたいときは godoc が使えます。