godocにてprivateなメンバも表示する方法について

投稿者: Anonymous

godocコマンド実行時はexportedメンバ/メソッドのみがドキュメントに出力されますが
内部設計書を作成したい目的でunexportedメンバ/メソッドも出力したく思っています。

godocのhelpを見てもそれらしきオプションが見当たらなかったのですが、
javadocの-privateオプションに相当するようなunexportedメンバの出力は不可能でしょうか?

※exported/unexportedという単語は
exported→先頭大文字メンバ
unexported→先頭小文字メンバ
の意です。

解決

GoDocを使ってHTMLを出力しているのであれば、URL末尾に ?m=all をつけると全ての宣言についてのドキュメントが表示されます。

たとえばこんな感じです。
https://golang.org/pkg/net/http/?m=all

CLIで操作していて、ファイルとして出力を得たいのであれば、godoc -url '/pkg/net/http/?m=all,text'のようなこともできます。

詳しくはgodocのGoDocに書かれています(”The presentation mode of web pages served by〜”の部分です)。

回答者: Anonymous

Leave a Reply

Your email address will not be published. Required fields are marked *