コーディング標準とベストプラクティス

すべてのプロジェクトに適用される普遍的なコーディング標準です。

適用時期

• 新しいプロジェクトやモジュールを開始するとき
• コード品質と保守性をレビューするとき
• 既存コードをリファクタリングして慣例に従わせるとき
• 命名規則、フォーマット、または構造の一貫性を強制するとき
• linting、フォーマット、または型チェックルールをセットアップするとき
• 新しい貢献者にコーディング慣例をオンボーディングするとき

コード品質の原則

1. 可読性を優先

• コードは書くより読まれることが多い
• 明確な変数名と関数名
• コメントより自己説明的なコード
• 一貫したフォーマット

2. KISS (Keep It Simple, Stupid)

• 機能する最もシンプルなソリューション
• 過度なエンジニアリングを避ける
• 早すぎる最適化をしない
• 賢いコードより理解しやすいコード

3. DRY (Don't Repeat Yourself)

• 共通ロジックを関数に抽出する
• 再利用可能なコンポーネントを作成する
• モジュール間でユーティリティを共有する
• コピー&ペーストプログラミングを避ける

4. YAGNI (You Aren't Gonna Need It)

...