クリーンコードガイド
このガイドについて
このガイドは、TypeScriptでクリーンで保守性の高いコードを書くための実践的な知識を提供します。単なるルール集ではなく、なぜそのルールが重要なのか、どのように適用するのかを段階的に理解できる構成になっています。
クリーンコードとは
クリーンコードとは、以下の特徴を持つコードです：
クリーンコードの特徴
- 読みやすい（意図が明確）
- 理解しやすい（複雑さが最小限）
- 変更しやすい（保守性が高い）
- テストしやすい（疎結合で高凝集）
- バグが少ない（予測可能な動作）
TypeScriptでクリーンコードを書く意義
TypeScriptは静的型付けを持つJavaScriptのスーパーセットです。型システムによってバグを減らせますが、良いコード設計なしには、その効果を十分に発揮できません。
章の一覧
| # | 章 | 概要 |
|---|---|---|
| 01 | 命名規則 ① ケース規約と変数・定数 | 4 つのケース規約の使い分け、変数・真偽値・定数の命名 |
| 02 | 命名規則 ② 関数とクラス | 動詞パターンによる関数命名、クラス名のサフィックス |
| 03 | 命名規則 ③ 命名の質を高める | 発音可能な名前・同義語の統一・省略の基準 |
| 04 | コメント | Why を書く、What はコードで表す |
| 05 | 変数の定義 | マジックナンバー禁止、const 優先、スコープ最小化 |
| 06 | 関数の定義 | 単一責任、純粋関数、早期リターン |
| 07 | 繰り返し処理 | forEach・map・filter・reduce の使い分け |
| 08 | 条件分岐 | 早期リターン、Discriminated Union、ポリモーフィズム |
| 09 | クラスとインターフェース | 単一責任、カプセル化、合成 |
| 10 | TypeScript 特有のベストプラクティス | any 禁止、unknown 活用、ジェネリクス |
| 11 | SOLID 原則 | 5 原則の TypeScript 実例 |
| 12 | まとめ | 全体像とチェックリスト |
規範を文書化するという視点
本ガイドは「TypeScript でクリーンに書く」ための具体的な規範集ですが、規範を文書化して運用に組み込む という考え方そのものに興味があれば、Blog の ハーネスエンジニアリング入門 もあわせてどうぞ。AI エージェント時代に rules / hooks / lint を harness として束ねる視点を整理しています。
学習ガイドの棲み分け
本ガイドは 設計規範のベストプラクティス に focus しており、既にコードを書ける人がコード品質を上げるためのリファレンスです。型の土台は TypeScript ガイド、設計の選択肢を広げるなら TypeScript デザインパターン へ続きます。サイト全体でどのガイドがどの段階を担うかは はじめに にまとめてあります。
5 原則をさらに掘り下げる
本ガイドの SOLID 原則 で定義を押さえたあと、なぜ守るのか・いつ破っていいのか・どう誤用されるかまで踏み込みたい場合は、SOLID 原則の深掘り があります。各原則の原典にあたり、現在どう再評価されているかまでを全 7 章で扱う中級以上向けの連載です。