コーディング

コーディング規約

公式ガイド:

• Effective Go - The Go Programming Language
• CodeReviewComments · golang/go Wiki … Goらしい書き方を学べる
  • 邦訳: Go Codereview Comments

Mixed Caps

• https://golang.org/doc/effective_go.html#mixed-caps
• https://github.com/golang/go/wiki/CodeReviewComments#mixed-caps

複数の単語から成る名前には以下のような命名を行う:

• mixedCaps … unexported
• MixedCaps … exported

定数でも同じ。
os.O_CREATE とかは他言語由来の一部の例外。

参考:

• constants - Go naming conventions for const - Stack Overflow

ドキュメントコメント

ドキュメンテーションコメント、いわゆるGoDocの書き方。

公式リソース:

• Effective Go - The Go Programming Language#Commentary
• Godoc: documenting Go code - The Go Blog
• Testable Examples in Go - The Go Blog

参考:

• チョットできるGoプログラマーになるための詳解GoDoc - Qiita
• GoDocドキュメントの書き方 - Plan 9とGo言語のブログ

Exampleをつける

上の参考記事を読むといい。

ポイント:

• テストコードとして記述する。 xxx_test.go というファイルに書く。
• package名はテスト対象のパッケージと異なる。 package xxx_test のように _test を付ける
  • 同じでも動くんだけど、Exampleとしては相応しくないコードになる

リファクタリング

関連項目:

• tools > gorename