コーディング¶
コーディング規約¶
公式ガイド:
Mixed Caps¶
- https://golang.org/doc/effective_go.html#mixed-caps
- https://github.com/golang/go/wiki/CodeReviewComments#mixed-caps
複数の単語から成る名前には以下のような命名を行う:
mixedCaps... unexportedMixedCaps... exported
定数でも同じ。
os.O_CREATE とかは他言語由来の一部の例外。
参考:
ドキュメントコメント¶
ドキュメンテーションコメント、いわゆるGoDocの書き方。
公式リソース:
- Effective Go - The Go Programming Language#Commentary
- Godoc: documenting Go code - The Go Blog
- Testable Examples in Go - The Go Blog
参考:
Exampleをつける¶
上の参考記事を読むといい。
ポイント:
- テストコードとして記述する。
xxx_test.goというファイルに書く。 - package名はテスト対象のパッケージと異なる。
package xxx_testのように_testを付ける- 同じでも動くんだけど、Exampleとしては相応しくないコードになる
リファクタリング¶
関連項目: