Great, now I know where to find the docs and how to read them. 次の質問は、自分のコードにもそのようなドキュメントを作成できるのか、また、どのように自分のコードをドキュメント化するのか、ということです。 つまり、次のようなコードがあるとします。

package matherfunc Add(first, second int) int {
return first + second
}

この package と function のためだけのドキュメントをどのように作成すればよいでしょうか。

The format

このブログ投稿で見つけたように、コードをドキュメント化する「特別な形式」がないようです。 @linkや@seeのような新しいものを導入するJavaDocと比較すると、そのようなことはありません。 コードを文書化するときは、「簡単なコメント」を作成すればいいのです。

唯一の要件は、最初の単語が関数の名前であることです。 あるいは、packageを文書化するときPackage。

// Package which provides some math methods
package mather// Add the first and second integer together 
// and return it
func Add(first, second int) int {
return first + second
}

Generate the doc

残念ですが、文書を生成することはできないのです! 少なくとも私が望むような方法ではありません。 私は、自分のプロジェクトについてだけ記述した HTML のドキュメントを作成できると仮定しました。 しかし、GOROOT と GOPATH にあるすべての go ファイルのドキュメントしか作成できません。

GOPATH については go で重要なことなので、後で別の記事を作成する予定です。 しかし、今は、ハードディスクにあるすべての go ファイルを保存する場所だと考えてください。

しかし、ドキュメントに戻ります。 godoc ツールで作成することができます。 godoc -http=:6060 を実行すると、ローカルホストの 6060 番ポートで Web サーバーが起動し、「ドキュメント」を見ることができます。