Go 関数設計

このスキルが適用されない場合: 関数型オプションコンストラクタ (WithTimeout, WithLogger) については go-functional-options を参照してください。エラーリターン規約については go-error-handling を参照してください。関数およびメソッドの命名については go-naming を参照してください。

---

関数のグループ化と順序付け

ファイル内の関数を以下のルールに従って整理します:

1. 関数は大まかな呼び出し順序でソート
2. 関数は受信者でグループ化
3. エクスポートされた関数は struct/const/var 定義の後に最初に出現
4. NewXxx/newXxx コンストラクタは型定義の直後に出現
5. プレーンユーティリティ関数はファイルの末尾に向かって出現

type something struct{ ... }

func newSomething() *something { return &something{} }

func (s *something) Cost() int { return calcCost(s.weights) }

func (s *something) Stop() { ... }

func calcCost(n []int) int { ... }

---

関数シグネチャ

マルチラインシグネチャのフォーマット、リターン値のラッピング、呼び出しサイトの短縮、またはナックボール（naked bool）パラメータをカスタム型に置き換える際は references/SIGNATURES.md を参照してください。

可能な限りシグネチャは1行に保ちます。ラップする必要がある場合は、すべての引数を独立した行に配置し、末尾のカンマを付与します:

func (r *SomeType) SomeLongFunctionName(
    foo1, foo2, foo3 string,
    foo4, foo5, foo6 int,
) {
    foo7 := bar(foo1)
}

曖昧な引数には /* name */ コメントを追加します。あるいはさらに良く、ナックボール bool パラメータをカスタム型に置き換えます。

---

インターフェースへのポインタ

インターフェースへのポインタがほぼ必要になることはありません。インターフェースを値として渡します — 基礎となるデータはそれでもポインタになります。

// 悪い例: インターフェースへのポインタ
func process(r *io.Reader) { ... }

// 良い例: インターフェース値を渡す
func process(r io.Reader) { ... }

---

Printf と Stringer

%v/%s/%d を超える Printf 動詞を使用する場合、fmt.Stringer または fmt.GoStringer を実装する場合、カスタム Format() メソッドを作成する場合、または String() メソッドの無限再帰をデバッグする場合は references/PRINTF-STRINGER.md を参照してください。

Printf スタイルの関数名

フォーマット文字列を受け入れる関数は go vet サポートのために f で終わる必要があります。Printf 呼び出しの外で使用されるフォーマット文字列は const で宣言します。

ロギングまたはエラーメッセージ用に文字列をフォーマットする場合は、手動クォートを使用した %s よりも %q を優先します — 特殊文字を安全にエスケープしてクォートで囲みます:

return fmt.Errorf("unknown key %q", key) // 出力: unknown key "foo\nbar"

3個以上のオプションパラメータを持つコンストラクタを設計する場合は go-functional-options を参照してください。

---

クイックリファレンス

トピック	ルール
ファイル順序	型 -> コンストラクタ -> エクスポート -> 非エクスポート -> ユーティリティ
シグネチャラッピング	すべての引数を独立した行に配置し末尾のカンマを付与
ナックパラメータ	/* name */ コメントを追加するか、カスタム型を使用
インターフェースへのポインタ	ほぼ必要なし。インターフェースを値で渡す
Printf 関数名	go vet サポートのために f で終わる

---

関連スキル

• エラーリターン: エラーリターンパターンの設計またはマルチリターン関数でのエラー折り返しについては go-error-handling を参照してください
• 命名規約: 関数、メソッドの命名またはゲッター/セッターパターンの選択については go-naming を参照してください
• 関数型オプション: 3個以上のオプションパラメータを持つコンストラクタを設計する場合は go-functional-options を参照してください
• フォーマット原則: 行長、ナックリターン、またはシグネチャフォーマットについて判断する際は go-style-core を参照してください