コードスタイルとフォーマッタ（一定の規約） — チーム開発品質
チーム開発では「コードの書き方が人によってバラバラ」だとレビューや保守が大変になります。
そこで コードスタイルの統一 と フォーマッタの利用 が重要です。初心者向けに、基本ルールとツールの使い方を例題で解説します。
コードスタイルの基本ルール
- インデント: スペース4つ（またはタブ）で統一。
- 波括弧
{}の位置: 開始は改行せず同じ行に置く。 - 命名規則:
- クラス名 → PascalCase（例:
UserService） - メソッド・変数名 → camelCase（例:
getUserName） - 定数 → 全て大文字＋アンダースコア（例:
MAX_VALUE）
- クラス名 → PascalCase（例:
- 行の長さ: 100〜120文字以内。
- 空行: 論理的なまとまりごとに1行空ける。
コード例（スタイル統一）
良い例
public class UserService {
private final UserRepository repository;
public UserService(UserRepository repository) {
this.repository = repository;
}
public User findUserById(int id) {
return repository.findById(id);
}
}
悪い例（バラバラ）
public class user_service{
private UserRepository repo;
public user_service(UserRepository r){repo=r;}
public User FindUserById(int ID){return repo.findById(ID);}
}
👉 悪い例は「インデントなし」「命名規則バラバラ」「読みづらい」。レビューで指摘が増える。
フォーマッタの活用
- IDEの自動整形:
- IntelliJ IDEA →
Ctrl + Alt + L - Eclipse →
Ctrl + Shift + F
- IntelliJ IDEA →
- 外部ツール:
- Google Java Style Guide に準拠した
google-java-format - Maven/Gradle プラグインでビルド時に自動整形可能。
- Google Java Style Guide に準拠した
👉 メリット: 人間が「どこにスペースを入れるか」で悩まなくて済む。レビューは「ロジック」に集中できる。
例題で練習
例題1: フォーマッタ適用前
public class Calculator{
public int add(int a,int b){return a+b;}
public int multiply(int a,int b){return a*b;}
}
例題2: フォーマッタ適用後
public class Calculator {
public int add(int a, int b) {
return a + b;
}
public int multiply(int a, int b) {
return a * b;
}
}
👉 自動整形で「インデント」「スペース」「改行」が統一される。
テンプレート集（チーム規約例）
クラス命名
public class OrderService { ... }
メソッド命名
public void processOrder() { ... }
定数命名
public static final int MAX_RETRY = 3;
インデントと括弧
if (condition) {
doSomething();
}
実務でのコツ
- 規約を文書化: チームで「Javaコードスタイルガイド」を共有。
- 自動化: IDE設定やビルドツールで強制。人間が直すより効率的。
- レビューで指摘しない: スタイルはフォーマッタに任せ、レビューは設計・ロジックに集中。
- CIでチェック: Checkstyle, Spotless などで自動検証。
まとめ
- コードスタイル統一はチーム品質の基本。
- フォーマッタを使えば自動で整形できる。
- 命名規則・インデント・括弧位置を統一すると読みやすさが向上。
- レビューはロジックに集中できる。
👉 練習課題として「フォーマッタを使わずに書いたコード」を自動整形して比較すると、統一の効果が体感できます。