godoc - gophersjp/go GitHub Wiki

memo

詳細は http://godoc.org/github.com/gophersjp/go を見ること。

-http 編（起動時）：

• godoc -http=:6060 でローカルにドキュメントサーバを起動できる
• godoc -http=:6060 -index で検索が有効になる
• godoc -http=:6060 -write_index=true -index_files index_file をつけると index_file にインデックスが保存される
• godoc -http=:6060 -index_files index_file で index_file からインデックスを読み込む

-http 編（操作）：

• パッケージのページURLのクエリに?m=allとすると宣言された全ての内容が表示される

godoc忘備録

• go docコマンドは無くなった https://code.google.com/p/go/source/detail?r=93fe65926d2c415b623f52f689e2f3c898a1a2c5&name=a2e6a2fddcf5

• go getするとgodocは$GOROOT/bin以下に配置されるようになってる？ https://code.google.com/p/go/source/detail?r=a2e6a2fddcf56a81ae68fe5901edc4a92581e906&name=a2e6a2fddcf5

• Synopsis (例えばココのページ: http://golang.org/cmd/ )はドット(. )を見て文を短縮してる。日本語にすると問題が出る。 https://code.google.com/p/go/source/browse/src/pkg/go/doc/synopsis.go?r=0b312b2f362b470761094d82ab5daf788fbb48ca#65

• godoc上に表示したくないパッケージを書くには '_' もしくは '.' で始まるディレクトリ名にする https://code.google.com/p/go/source/browse/godoc/dirtrees.go?repo=tools#49

翻訳メモ

• -links

  • 詳細: http://golang.org/src/cmd/godoc/linkify.go?h=LinkifyText#L27

• -zip

  • 例: zip -r go.zip $HOME/go -i \*.go -i \*.html -i \*.css -i \*.js -i \*.txt -i \*.c -i \*.h -i \*.s -i \*.png -i \*.jpg -i \*.sh -i favicon.ico

実装が見当たらない?フラグ：

• -maxresults
• -notes