コードスタイル: 命名規則

一貫性のあるコードで可読性を高める。

PascalCase
クラス名に使用。
camelCase
メソッド・変数に使用。
Javadoc
ドキュメントコメント。
Grammar Rules

コードスタイルは「文法ルール」。 **命名規則** = スペルと大文字 **インデント** = 段落 一貫性がないと読みにくい。

コードスタイル

Naming conventions
// Java コードスタイル


// クラス名: PascalCase
public class UserService { }


// メソッド名: camelCase
public void findUserById(Long id) { }


// 定数: SCREAMING_SNAKE_CASE
public static final int MAX_RETRY_COUNT = 3;


// パッケージ名: 小文字
package com.example.myapp.service;


// インターフェース: 形容詞または名詞
public interface Runnable { }
public interface UserRepository { }


// 例外クラス: XxxException
public class UserNotFoundException extends Exception { }
命名規則
Class: PascalCase\nMethod: camelCase\nConstant: SCREAMING_SNAKE_CASE
Bad
// ❌ Bad: 一貫性がない
public class user_service {  // スネークケース
    public void FindUser() { }  // パスカルケース
    int x;  // 意味不明
}
Good
// ✅ Good: 標準に従う
public class UserService {      // パスカルケース
    public void findUser() { }  // キャメルケース
    int retryCount;             // 意味のある名前
}

ルール

Google Style, Javadoc, Checkstyle
// Google Java Style Guide の主要ルール


// 1. インデント: スペース2つ（または4つ）
// 2. 行の長さ: 100文字以内
// 3. ブレース: K&R スタイル
if (condition) {
    doSomething();
} else {
    doOther();
}


// 4. import の順序
// - 静的 import
// - java.*
// - javax.*
// - サードパーティ
// - 自プロジェクト


// 5. Javadoc
/**
 * ユーザーを検索する。
 *
 * @param id ユーザーID
 * @return ユーザー（見つからない場合は null）
 * @throws IllegalArgumentException id が null の場合
 */
public User findById(Long id) { }


// フォーマッター
// IntelliJ: Code > Reformat Code (Ctrl+Alt+L)
// Eclipse: Source > Format (Ctrl+Shift+F)
// google-java-format: 自動フォーマット


// Checkstyle / SpotBugs
// mvn checkstyle:check
// mvn spotbugs:check
Tip: フォーマッターを設定してチームで統一。

合格ライン

☐ 命名規則を守れる
☐ Javadoc を書ける

参考リンク

Google Java Style

演習課題

課題1: 命名規則
既存のコードを Google Java Style に準拠させてください。
課題2: Javadoc
クラスにJavadocコメントを追加してください。

次のステップ

テスト
JUnit 5