code-quality-review

コード品質レビュー

概要

保守性、可読性、複雑さ、デザインパターン、命名規則、コードの重複、ベストプラクティスへの準拠など、複数の観点から体系的にコード品質を分析します。重大度評価と具体的な改善提案を添えた、実行可能なフィードバックを提供します。

主な機能

1. コードの不吉な臭いの検出 - 肥大化、オブジェクト指向の誤用、変更を妨げる要因、不要な要素、結合の問題を特定します
2. 複雑さの分析 - 循環的複雑度と認知的複雑度を測定し、リスクを評価します
3. 保守性の評価 - コードの保守性指標と技術的負債を評価します
4. デザインパターンの評価 - アーキテクチャパターンと SOLID 原則をレビューします
5. ベストプラクティスの検証 - 言語固有の標準や規約への準拠を確認します

レビューワークフロー

ステップ 1：対象範囲の評価

変更の規模に基づいてレビューの対象範囲を決定します。

• 小規模（100 行未満）：簡易的な正確性チェック、15～30 分
• 中規模（100～500 行）：品質の全面的な分析、1～2 時間
• 大規模（500 行超）：アーキテクチャレビュー。可能であれば小さなレビューに分割し、2～4 時間

対象範囲ごとのガイダンスについては、review-scope-guidelines.md を参照してください。

ステップ 2：初期評価

コンテキストの把握：

• プログラミング言語とフレームワークを特定します
• プロジェクトの種類（Web アプリ、API、ライブラリ、CLI など）を把握します
• 既存のコーディング標準やスタイルガイドを確認します
• リンター設定ファイル（.eslintrc、.pylintrc、checkstyle.xml など）を確認します

コードの確認：

• エントリーポイント（メインファイル、インデックスファイルなど）から確認を始めます
• モジュールやパッケージの構成をレビューします
• 依存関係の管理方法を確認します
• 利用可能な場合はテストファイルを確認します

ステップ 3：品質分析

以下の主要な観点からコードを分析します。

• コードの不吉な臭い：長いメソッド、大きなクラス、重複コード、デッドコードなど
• 複雑さ：循環的複雑度（目標値：15 未満）、認知的複雑度、ネストの深さ
• 保守性：明確な命名、適切な抽象化、関心事の分離
• デザインパターン：適切なパターンの使用、SOLID 原則への準拠
• ベストプラクティス：言語固有の慣用表現、エラー処理、リソース管理

詳細な分析基準としきい値については、review-workflow.md を参照してください。

品質指標としきい値については、quality-metrics-reference.md を参照してください。

ステップ 4：調査結果の記録

レビュー報告書は、以下の構成にします。

• スコアと最優先事項を含むエグゼクティブサマリー
• 重大度、該当箇所、説明、推奨事項を含む詳細な調査結果
• 現在値と目標値を比較する指標の概要
• 優先順位付けされた推奨事項（P0～P3）
• 優れた実践を評価する肯定的な所見
• 工数の見積もりを含む技術的負債の概要

報告書の完全な構成と出力ガイドラインについては、review-report-format.md を参照してください。

品質保証

包括的なレビューを行うため、次のチェックリストを使用します。

• コードの構成と構造
• 命名規則と明確さ
• 複雑度のしきい値
• エラー処理のパターン
• テストとドキュメント
• セキュリティ上の考慮事項
• パフォーマンスへの影響

完全なチェックリストについては、best-practices-checklist.md を参照してください。

よくある落とし穴

次のようなレビュー上のよくある誤りを避けてください。

• 実質的な問題ではなく、スタイル上の問題ばかりに注目する
• 実行可能な提案をせず、過度に批判的になる
• コンテキストやビジネス上の制約を無視する
• 一度に多くの問題を挙げすぎる
• 説明なしに曖昧な表現を使う
• 優れた実践を評価するのを忘れる

詳しいガイダンスについては、common-pitfalls-to-avoid.md を参照してください。

パターンの例

レビューで重大な問題を特定する際の参考として、重大度の高いよくある問題の例を critical-issues.md で確認してください。