Go命名規約

利用可能なスクリプト

• scripts/check-naming.sh — Go コードの命名アンチパターンをスキャンします: SCREAMING_SNAKE_CASE定数、Get接頭辞のゲッター、悪いパッケージ名(util/helper/common)、"this"/"self"という名前のレシーバー。bash scripts/check-naming.sh --helpで詳細なオプションを確認できます。

基本原則

名前は以下を満たすべきです:

• 使用時に繰り返されないこと
• コンテキストを考慮すること
• 既に明確な概念を繰り返さないこと

命名は科学というより芸術です。Go の名前は他の言語よりも短い傾向があります。

---

命名判定フロー

何を命名していますか?
├─ パッケージ   → 短い、小文字、単数形の名詞(アンダースコア、mixedCapsなし)
├─ インターフェース → メソッド名 + "-er"接尾辞(単一メソッドの場合)(Reader, Writer)
├─ レシーバー   → 型の1-2文字の省略(Client の場合は c); メソッド間で一貫性を保つ
├─ 定数        → MixedCaps; iota を列挙型に使用; ALL_CAPS は禁止
├─ エクスポート関数 → MixedCaps の動詞または動詞句; ゲッターに Get 接頭辞なし
├─ 変数        → スコープの距離に比例した長さ
│              ├─ 小さいスコープ(1-7行) → 単一文字(i, n, r)
│              ├─ 中程度のスコープ      → 短い単語(count, buf)
│              └─ パッケージレベル/広範囲 → 説明的(userAccountCount)
└─ 任意の名前   → 確認: パッケージ名またはコンテキストを繰り返していないか? はい の場合、短縮する

---

MixedCaps(必須)

Normative: すべての Go 識別子は MixedCaps を使用する必要があります。

アンダースコアが許可される範囲: テスト関数(TestFoo_InvalidInput)、生成されたコード、OS/cgo相互運用のみです。

---

パッケージ名

Normative: パッケージは小文字で、アンダースコアなしである必要があります。

短く、小文字、単数形の名詞です。util、common、helperといった一般的な名前は避けてください。特定の名前を選びましょう: stringutil、httpauth、configloader。

// 良い: user, oauth2, tabwriter
// 悪い: user_service, UserService, count (変数をシャドウイング)

パッケージの命名、インポートエイリアスの決定、または一般的な名前と特定の名前の選択時は references/IDENTIFIERS.md を参照してください。

---

インターフェース名

Advisory: 単一メソッドインターフェースは"-er"接尾辞を使用します。

単一メソッドインターフェースはメソッド名に-erを付けます: Reader、Writer、Formatter。標準的なメソッド名(Read、Write、Close、String)とそのシグネチャを遵守してください。

新しいインターフェースを定義するか、既知のメソッドシグネチャを実装する場合は references/IDENTIFIERS.md を参照してください。

---

レシーバー名

Normative: レシーバーは短い省略形であり、一貫して使用する必要があります。

型を省略した1-2文字で、すべてのメソッドで一貫性を保ちます: func (c *Client) Connect()、func (c *Client) Send()。 thisやselfを使用しないでください。

レシーバー名を選択するか、メソッド間で一貫性を確保する場合は references/IDENTIFIERS.md を参照してください。

---

定数名

Normative: 定数は MixedCaps を使用し、ALL_CAPS または K 接頭辞は使用しません。

定数を値ではなく役割で命名します: ThreeではなくMaxRetries、Port8080ではなくDefaultPort。

const MaxPacketSize = 512
const defaultTimeout = 30 * time.Second

定数を命名するか、役割ベースと値ベースの名前の選択時は references/IDENTIFIERS.md を参照してください。

---

イニシャリズムと頭字語

Normative: イニシャリズムは大文字と小文字を一貫して保ちます。

イニシャリズム(URL、ID、HTTP、API)は大文字または小文字で統一します: HTTPClient、userID、ParseURL() — HttpClient、orderId、ParseUrl()ではなく。

複合名でイニシャリズムを使用する場合または完全な大文字小文字テーブルについては references/IDENTIFIERS.md を参照してください。

---

関数とメソッド名

Advisory: 単純なアクセサーにGet接頭辞を使用しません; アクションには動詞のような名前を使用します。

フィールドownerのゲッターはGetOwner()ではなくOwner()です。セッターはSetOwner()です。高コストな操作にはComputeまたはFetchを使用してください。

関数が型によってのみ異なる場合、型を末尾に含めます: ParseInt()、ParseInt64()。

ゲッター/セッター API を設計するか、関数バリアントを命名する場合は references/IDENTIFIERS.md を参照してください。

---

変数名

変数命名は簡潔さと明確さのバランスを取ります。主要な原則:

• スコープベースの長さ: 小さいスコープには短い名前(i、v); 大きいスコープには長い説明的な名前
• 単一文字の規約: 見慣れたパターンを使用(iはインデックス、r/wはリーダー/ライター)
• 名前に型を含めない: userSliceではなくusers、nameStringではなくnameを使用
• エクスポートされていないグローバルに接頭辞を付ける: パッケージレベルのエクスポートされていない変数/定数に_接頭辞を使用してシャドウイングを防止

for i, v := range items { ... }           // 小さいスコープ
pendingOrders := filterPending(orders)    // 大きいスコープ
const _defaultPort = 8080                 // エクスポートされていないグローバル

15行を超える関数内のローカル変数を命名する場合は references/VARIABLES.md を参照してください。

---

繰り返しを回避する

Go の名前は使用時に繰り返されるような感じを与えるべきではありません。完全なコンテキストを考慮してください:

• パッケージ + シンボル: widget.NewWidget()ではなくwidget.New()
• レシーバー + メソッド: p.ProjectName()ではなくp.Name()
• コンテキスト + 型: sqldbパッケージではDBConnectionではなくConnectionを使用

パッケージ名とそのエクスポートされたシンボルが冗長に感じられる場合は references/REPETITION.md を参照してください。

---

組み込み名を回避する

Go の事前宣言識別子(error、string、len、cap、append、copy、new、make等)を変数、パラメータ、または型名としてシャドウイングしないでください。

詳細ガイダンス: go-declarations — "Avoid Using Built-In Names"セクションを参照してください。

---

クイックリファレンス

要素	ルール	例
パッケージ	小文字、アンダースコアなし	package httputil
エクスポート	MixedCaps、大文字で始まる	func ParseURL()
エクスポート非	mixedCaps、小文字で始まる	func parseURL()
レシーバー	1-2文字の省略	func (c *Client)
定数	MixedCaps、ALL_CAPS は禁止	const MaxSize = 100
イニシャリズム	一貫した大文字小文字	userID、XMLAPI
変数	長さ ~ スコープサイズ	i(小)、userCount(大)
組み込み名	事前宣言識別子をシャドウイングしない	go-declarationsを参照

検証: 識別子の名前変更後、bash scripts/check-naming.shを実行して命名アンチパターンが残っていないことを確認します。次にgo build ./...を実行して、名前変更が何も壊していないことを確認します。

関連スキル

• インターフェース命名: -er接尾辞でインターフェースを命名するか、レシーバー型を選択する場合は go-interfaces を参照してください
• パッケージ命名: パッケージを命名する、util/commonを回避する、またはインポート衝突を解決する場合は go-packages を参照してください
• エラー命名: センチネルエラー(ErrFoo)またはカスタムエラー型を命名する場合は go-error-handling を参照してください
• 宣言スコープ: 変数名の長さがスコープに依存する場合、または組み込みのシャドウイングを回避する場合は go-declarations を参照してください
• スタイル原則: 識別子名で明確さと簡潔さのバランスを取る場合は go-style-core を参照してください