Unity C#スクリプトの命名規則

UnityのC#スクリプトにおける命名規則は、コードの可読性を向上させ、保守しやすくするために重要です。この資料では、Unityの開発における推奨される命名規則を紹介します。

目的

本資料の目的は、Unityの開発における命名規則を統一し、プロジェクト全体のコードを整理された状態に保つことです。特に、初心者がこれらの規則を理解し、正確に適用できるよう支援することを目指します。

1. クラス名

  • 規則: PascalCaseを使用する。
  • 説明: 各単語の頭文字を大文字にし、単語を連結して命名します。
  • 例:
    • 正しい例: PlayerController, GameManager
    • 間違った例: playercontroller, game_manager

2. メソッド名

  • 規則: PascalCaseを使用する。
  • 説明: メソッド名は動詞で始めることが多く、各単語の頭文字を大文字にします。
  • 例:
    • 正しい例: MovePlayer, SpawnEnemy
    • 間違った例: moveplayer, spawn_enemy

3. フィールド（変数）名

  • 規則: camelCaseを使用する。
  • 説明: 最初の単語の頭文字は小文字、それ以降の単語の頭文字は大文字にします。プライベートフィールドには、場合によってアンダースコアを使うこともあります。
  • 例:
    • 正しい例: playerHealth, enemySpeed
    • 間違った例: PlayerHealth, Enemy_speed

4. 定数

  • 規則: 全て大文字で、単語の間をアンダースコアで区切る。
  • 説明: 定数は固定された値を保持するため、視覚的に区別しやすくするために大文字を使います。
  • 例:
    • 正しい例: MAX_PLAYER_HEALTH, DEFAULT_SPEED
    • 間違った例: MaxPlayerHealth, defaultSpeed

5. プロパティ

  • 規則: PascalCaseを使用する。
  • 説明: プロパティは変数にアクセスするためのメソッドであり、フィールド名と異なる命名規則を適用します。
  • 例:
    • 正しい例: Health, Speed
    • 間違った例: health, speed

6. 列挙型 (Enum)

  • 規則: PascalCaseを使用する。
  • 説明: Enum自体とそのメンバはPascalCaseで記述し、明確に意味が分かる名前をつけます。
  • 例:
  public enum GameState
  {
      Start,
      Playing,
      GameOver
  }

7. 名前空間

  • 規則: PascalCaseを使用する。
  • 説明: プロジェクトが大規模になると、名前空間を使ってクラスのグループを整理します。
  • 例:
    • 正しい例: MyGameProject.Input, MyGameProject.Managers
    • 間違った例: mygameproject.input, My_game_project.Managers

8. ファイル名

  • 規則: クラス名と一致させる。
  • 説明: 各C#スクリプトのファイル名は、そのファイルに含まれるクラス名と同じにします。
  • 例:
    • 正しい例: PlayerController.cs
    • 間違った例: playercontroller.cs

9. イベント

  • 規則: PascalCaseを使用し、過去形で命名する。
  • 説明: イベント名は、発生した動作を明示するために過去形で命名します。
  • 例:
    • 正しい例: OnPlayerDied, OnGameStarted
    • 間違った例: PlayerDie, GameStart

10. インターフェース

  • 規則: 頭にIをつけ、PascalCaseで記述する。
  • 説明: インターフェース名はIで始める慣習があります。
  • 例:
    • 正しい例: IDamageable, IMovable
    • 間違った例: DamageableInterface, MovableInterface

11. Unityの組み込みメソッド

  • 説明: UnityのMonoBehaviourを継承するクラスでは、Start() や Update() などの組み込みメソッドは特定の名前が決まっているため、これらを変更しないようにします。

結論

命名規則を統一することで、コードの可読性が向上し、チームでの共同開発がスムーズになります。Unityの命名規則を守ることで、他の開発者や将来の自分がコードを理解しやすくなるため、積極的に取り入れることを推奨します。

この資料を使って、Unity開発における命名規則の基準を生徒に説明する際に役立ててください。

C#

Posted by hidepon