Effective Go について
Effective Go は、Go コードの作成、レビュー、リファクタリングに使うスキルです。公式ガイドに基づき、書式、エラー処理、命名、並行処理の規約を示します。
主な機能
- 01Go の慣用的な書き方
- 02gofmt による書式規約
- 03命名とエラー処理の実践
- 04並行処理とインターフェースの指針
- 05ドキュメント作成規約
活用シーン
- 01Go コードの新規作成
- 02既存 Go コードのレビュー
- 03Go 実装のリファクタリング
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ openshift/ hypershift --skill effective-goインストール後、Claude Code で/effective-goを入力して読み込まれたか確認します。
詳細
Effective Go
公式の Effective Go ガイド にあるベストプラクティスと規約を適用して、読みやすく慣用的な Go コードを書きます。
適用する場面
次の場合に、このスキルを自動的に使用します。
- 新しい Go コードを書くとき
- Go コードをレビューするとき
- 既存の Go 実装をリファクタリングするとき
主な注意事項
https://go.dev/doc/effective_go に記載された規約とパターンに従い、特に次の点に注意してください。
- フォーマット:必ず
gofmtを使用してください。これは譲れないルールです。 - 命名:アンダースコアは使わず、エクスポートする名前には MixedCaps、エクスポートしない名前には mixedCaps を使用してください。
- エラー処理:必ずエラーを確認してください。エラーは返し、panic は使わないでください。
- 並行処理:通信によってメモリーを共有してください(チャネルを使用します)。
- インターフェース:小さく保ち(1~3 個のメソッドが理想です)、インターフェースを受け取り、具象型を返してください。
- ドキュメント:エクスポートするすべてのシンボルについて、そのシンボル名から始まるドキュメントを記述してください。
参考資料
- 公式ガイド:https://go.dev/doc/effective_go
- コードレビューコメント:https://github.com/golang/go/wiki/CodeReviewComments
- 標準ライブラリ:慣用的なパターンの参考として使用してください
コメント
Markdown 対応