godoc コメントの書き方

godoc サーバーの起動

以下のコマンドで godoc サーバーが起動する。
ブラウザから http://localhost:6060 にアクセスすれば、GOPATH 配下のソースのドキュメントを参照することができる。

godoc -http=:6060

パッケージコメント

package の上に記述する。
http://godoc.org/-/index などの一部のページでは、コメントの先頭から句読点、ピリオドまでしか表示されない。
また、同一パッケージ内にパッケージコメントが記述されているファイルが複数ある場合は、ファイル名順でソートした際の先頭のファイルのコメントが採用されるよう。

// Package Overview.
// hogehoge...
package main

関数コメント

func の上に記述する。

// Function Overview.
func doSomething() string {
    ...
}

ソースコードの埋め込み

半角スペース2個以上のインデントでコードの埋め込みが可能。

// Example:
//     obj, err := doSomething()
//     handleError(err)