Go言語基本編 go docコマンドの使い方・例文詳細編

ゴー・ドック

は、ドキュメントを素早く生成し、それを見るためのツールを提供し、ドキュメントを書きやすく、見やすくしてくれます

I. go docコマンドを使用してターミナルで表示する

go doc パッケージ

パッケージのドキュメントコメントを取得する
例

go doc fmt は godoc を使って生成された fmt パッケージのドキュメント・コメントを表示します。

go doc パッケージ/サブパッケージ

サブパッケージのドキュメントコメントを取得する
例

go doc コンテナ/リスト

go doc パッケージ機能

パッケージ内の関数のドキュメントを取得する
例

go doc fmt Printfにfmt.Printf()の使い方が表示されています。

注意事項

これらのコマンドを使用して、カスタムのものも表示します。

• 1. GOPATHを設定する必要があります
• 2.カスタムパッケージがsrcの下にあること

2つ目は、ブラウザビューを利用する方法

godoc コマンドを使用すると、ローカルでウェブサービスを開始することができ、ブラウザを開くことでアクセスして Go ドキュメントを表示することができます。

godoc -http=<domain>:<port number>

例えば、godoc -http=localhost:8080 です。そして、ブラウザで 127.0.0.1:8080 を開くと、golang.org のローカルコピーが表示され、そこから pkg ドキュメントのような他のものを問い合わせることができるようになります。ウェブサービスを閉じると、黒いウィンドウが閉じます

パッケージを見るには
localhost:8080/pkg/

以上、Go言語基本コマンドの使い方と例を詳しく説明しましたが、Go言語基本コマンドの詳細については、スクリプトハウスの他の関連記事にも目を通してみてください