godocでローカルドキュメント【Go】

godocの起動

ローカル環境のドキュメントを閲覧するページを立ち上げることができます。
godocが未インストールの場合は、下記を実行します。

$ go get golang.org/x/tools/cmd/godoc

godocがインストールされている状態で、下記を実行します。

$ godoc -http=:6060

http://localhost:6060にアクセスします。
すると、公式godocと同じようなページが表示されますが、
記載されている情報は、ローカル環境における情報です。

godocの編集

package、type、変数、関数、メソッドなどについてコメントを直上に記載して保存すると、
http://localhost:6060のgodocに反映されます。

packageと関数にコメントを記載した例です。

// Package mylib is the special one.
package mylib

//Average returns
func Average(s []int) int {
    var sum int
    for _, v := range s {
        sum += v
    }
    return sum / len(s)
}

f:id:tech-up:20181204181948p:plain f:id:tech-up:20181204182134p:plain

また、次のようにExampleを記載することもできます。
Exampleは「<ファイル名>test.go」に記載します。

Example()で、package全体の例示、
Example<関数名>()で、関数の例示、
Example<type名><メソッド名>()で、メソッドの例示になります。

func Example() {
    s := []int{1, 2, 3, 4, 5, 6, 7}
    fmt.Println(Average(s))
}

func ExampleAverage() {
    s := []int{1, 2, 3, 4, 5}
    fmt.Println(Average(s))
}

func ExamplePerson_Say() {
    p := Person{Name: "DeRozan", Age: 29}
    p.Say()
}

f:id:tech-up:20181204182644p:plain f:id:tech-up:20181204182836p:plain f:id:tech-up:20181204183018p:plain