実際の開発において、最初の1行目からコードを書くことはほとんどありません。通常は他の人のコードをベースに自分の作業を構築します。自分のコードをメンテナンスしやすくすることで、他の開発者が効率的に作業を進められるようになります。
① 理解しやすいコード
元の開発者に頼らなくても、誰が見てもそのコードが何をするものかが分かるようにする。
実践方法:
• 関数やメソッドに適切なコメントを追加し、その目的を説明する。
• その関数やメソッドを使用するための前提条件、各パラメータの意味、戻り値の有無を明確にする。
• 大規模なコードブロックや複雑なアルゴリズムにも説明を加える。
② 常識に合ったコード
コード全体が直感的で、複雑な操作でも筋が通っているように見える。
実践方法:
• 変数名と関数名の適切な命名:
• 変数名は名詞を使う（例: card、person、sex）。
• 関数名は動詞で始める（例: getInfo、getList）。
• ブール値を返す関数は is で始める（例: isDialog()）。
• 定数はすべて大文字にし、アンダースコアで単語をつなぐ（例: BASE_URL_API）。
• 命名には説明的で直感的な単語を使うが、冗長にならないように注意する。
③ 適応しやすいコード
データが変化しても、コード全体を書き直す必要がないようにする。
実践方法:
• サーバーから返される状態コード（例: statusCode）に基づいた条件分岐を設計する。
• CSSスタイルを記述する際は、テキストの長さやPC版・モバイル版での内容の超過を考慮する。
④ 拡張しやすいコード
コードの設計を丁寧に行い、将来の機能拡張をサポートできるようにする。
実践方法:
• 使用するデザインパターン:
• シングルトンパターン
• ファクトリーパターン
• ストラテジーパターン
• プロキシパターン
• デコレーターパターン
• オブザーバーパターン
• パブリッシャーサブスクライバーパターン
• 設計思想:
• オープン/クローズド原則（Open/Closed Principle）
• ポリモーフィズム（多態性）
• 低結合・高凝集