エンジニアリング標準

高品質なソフトウェアのための基礎原則です。以下の場合に使用してください:

• コードの品質問題をレビューする
• アーキテクチャの変更を計画する
• リファクタリングの機会を特定する
• 技術債を評価する

SOLID原則

単一責任の原則 (SRP)

クラス/モジュールは変更される理由が1つであるべきです。

検出パターン:

• 関連性のないことを行う5個以上のパブリックメソッドを持つクラス
• 50行を超えるメソッド
• クラス名に「And」や「Manager」を含み、関心事が混在している
• 10個以上の無関連なモジュールからインポートするファイル

リファクタリング:

• 各責任ごとにクラスを抽出する
• フォーカスされたモジュールに分割する
• 継承より合成を使用する

開閉原則 (OCP)

拡張に対して開かれ、修正に対して閉じているべきです。

検出パターン:

• 頻繁に追加されるタイプに対するSwitch/case文
• インスタンスタイプをチェックするif/else チェーン
• 新機能を追加するために既存コードを修正する

リファクタリング:

• 動作のバリエーションにはストラテジーパターンを使用する
• 拡張のためのプラグインアーキテクチャ
• 構成可能性のための依存性注入

...