
「動くコード」は最低ライン。「読めるコード」が求められる
「動くコード」は最低ライン。「読めるコード」が求められる
プログラミング学習中は
チーム開発では、
コードレビューで指摘されない5つの習慣
習慣1:変数名・関数名で意図を伝える
コードを
| 悪い例 | 良い例 | 理由 |
|---|---|---|
d | daysSinceLastLogin | 何を |
tmp | filteredUsers | 処理結果の |
flag | isAuthenticated | 真偽値の |
data | userProfile | データの |
handle | handleSubmitForm | 何を |
命名のルール
- 真偽値 —
is、has、canで始める(isLoading、hasPermission) - 配列 — 複数形にする(
users、products) - 関数 — 動詞で
始める( getUser、calculateTotal、validateEmail) - 定数 — 大文字スネークケース(
MAX_RETRY_COUNT、API_BASE_URL)
習慣2:関数を小さく保つ
1つの
目安として:
- 1関数
あたり20行以内を心がける - 関数名で
何をするかが 完結に 説明できる - 引数は3つ以下にする
長い
習慣3:ネストを浅く保つ
if文やループが
ネストを減らすテクニック
- 早期リターン — 条件を
満たさない 場合は 早めに 関数を 抜ける - ガード節 — 異常系の
チェックを 最初に 行い、 正常系の 処理を フラットに 書く - 処理の
分割 — 深いネストの 内部処理を 別関数に 切り出す
目安として、
読みやすい
習慣4:コメントは「なぜ」を書く
コメントは
- 悪い
コメント: // ユーザーを取得する(コードを読めばわかる) - 良い
コメント: // 退会済みユーザーも含める(管理画面では表示が必要なため)
コメントが不要なケース
- 変数名や
関数名で 意図が 伝わる 場合 - コードが
シンプルで 自明な 場合
コメントが必要なケース
- ビジネスロジック上の
理由がある 場合 - パフォーマンス上の
理由で 通常と 異なる 実装をしている 場合 - 一時的な
対応 (ワークアラウンド)の 場合 (TODO/FIXMEコメント)
習慣5:一貫性を保つ
チーム開発では、
- コーディング規約に
従う — ESLint、Prettierの設定に 従い、 自動フォーマットを 活用する - 既存コードの
パターンに — プロジェクト内で合わせる 統一された スタイルを 崩さない - ファイル構成の
ルールに — コンポーネントの従う 配置、 命名規則を 統一する
コードレビューで成長する
コードレビューは
指摘を受けたとき
- 感情的にならず、
指摘内容を 理解する - なぜそう
修正すべきかの 理由を 理解する - 同じ
指摘を 二度受けないよう、 学びを 蓄積する
自分でチェックするポイント
PRを
- 変数名・関数名は
意図が 伝わるか - 不要な
コードや console.logが 残っていないか - ネストが
深くなりすぎて いないか - 同じ
処理が 複数箇所に コピペされて いないか - エラーハンドリングが
適切か
読みやすいコードは「思いやり」の表現
読みやすい
ゆめさくエンジニアでは、18ヶ月の
初めての
レビューで
エラーハンドリングの
本番環境で
チーム開発の
Git/PR/レビューの
ゆめさくエンジニアの
18ヶ月で




