ホームページ > バックエンド開発 > Golang > 「godoc」を使用してブラウザで Go パッケージのドキュメントをローカルに表示するにはどうすればよいですか?

「godoc」を使用してブラウザで Go パッケージのドキュメントをローカルに表示するにはどうすればよいですか?

Barbara Streisand
リリース: 2024-12-02 02:24:09
オリジナル
954 人が閲覧しました

How Can I View My Go Package Documentation Locally in a Browser Using `godoc`?

ブラウザでローカルにパッケージ ドキュメントを表示する

パッケージを開発する場合、公開する前にドキュメントをローカルでプレビューすると便利です。 godoc コマンドはテキスト ドキュメントを生成できますが、ブラウザでドキュメントを表示するための HTTP サーバー モードも提供します。ただし、適切に動作させるのに問題が発生する可能性があります。

godoc -http=:6060 が独自のパッケージのドキュメントを表示せず、代わりに Go ホームページを表示するという問題が発生している場合は、パッケージは正しいパスにあります。デフォルトでは、godoc は GOPATH またはモジュール ソース ツリー内のパッケージを検索します。パッケージがこれらのディレクトリの外にある場合、パッケージは見つかりません。

GOPATH モード:

GOPATH モードで作業している場合、godoc -http はドキュメントを提供します。標準ライブラリを含む、利用可能なすべてのパッケージ。パッケージのドキュメントを表示するには、http://localhost:6060/pkg/your/package に移動します。

モジュール対応モード:

モジュール内-認識モードでは、godoc は GOPATH と互換性がありません。したがって、モジュールのドキュメントをローカルで表示するには、モジュールのソース コードを src フォルダーに配置する必要があります。たとえば、モジュールがディレクトリ /home/user/mymodule にある場合、その中に src という新しいディレクトリを作成し、モジュールのソース ファイルをそこに移動します。

ソース ファイルが src フォルダに配置されたら、次のコマンドを使用して godoc を起動します:

godoc -goroot=/home/user/mymodule -http=:6060
ログイン後にコピー

これにより、パッケージのドキュメントを次の場所で表示できるようになります。 http://localhost:6060/pkg/mymodule.

以上が「godoc」を使用してブラウザで Go パッケージのドキュメントをローカルに表示するにはどうすればよいですか?の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。

ソース:php.cn
このウェブサイトの声明
この記事の内容はネチズンが自主的に寄稿したものであり、著作権は原著者に帰属します。このサイトは、それに相当する法的責任を負いません。盗作または侵害の疑いのあるコンテンツを見つけた場合は、admin@php.cn までご連絡ください。
著者別の最新記事
人気のチュートリアル
詳細>
最新のダウンロード
詳細>
ウェブエフェクト
公式サイト
サイト素材
フロントエンドテンプレート