【Unity】コードスタイル

// 例: 式形式のプロパティ
public class PlayerHealth
{
    // プライベートのバッキングフィールド
    private int maxHealth;

    // 読み取り専用, バッキングフィールドを戻す
    public int MaxHealth => maxHealth;

    // これと同じ:
    // public int MaxHealth { get; private set; }
}

// 例: 式形式のプロパティ
public class PlayerHealth
{
    // バッキングフィールド
    private int _maxHealth;

    // ゲッターとセッターの明示的な実装
    public int MaxHealth
    {
        get => _maxHealth;
        set => _maxHealth = value;
    }

    // 書き込み専用 (バッキングフィールドを使わない)
    public int Health { private get; set; }

    // 書き込み専用, 明示的なセッターなし
    public SetMaxHealth(int newMaxValue) => _maxHealth = newMaxValue;

}

// 例: PlayerStats のシリアライズ可能なクラス

using System;
using UnityEngine;

public class Player : MonoBehaviour
{
    [Serializable]
    public struct PlayerStats
    {
        public int MovementSpeed;
        public int HitPoints;
        public bool HasHealthPotion;
    }

// 例: プライベート・フィールドはインスペクタに表示されます

    [SerializeField]
    private PlayerStats _stats;
}

// 例: オールマンやBSDのスタイルは、開く中括弧を新しい行に記述する

void DisplayMouseCursor(bool showMouse) 
{
     if (!showMouse)
     {
          Cursor.lockState = CursorLockMode.Locked;
          Cursor.visible = false;
     }
     else
     {
          Cursor.lockState = CursorLockMode.None;
          Cursor.visible = true;
     }
}

// 例: K&Rスタイルでは、開く中括弧を後ろに書く

void DisplayMouseCursor(bool showMouse){
     if (!showMouse) {
          Cursor.lockState = CursorLockMode.Locked;
          Cursor.visible = false;
     }
     else {
          Cursor.lockState = CursorLockMode.None;
          Cursor.visible = true;
     }
}

// 例: 中括弧を明確にしておく...

for (int i = 0; i < 100; i++) { DoSomething(i); }

// ...または違う行に書く
for (int i = 0; i < 100; i++)
{
    DoSomething(i);
}

// 避ける: 中括弧の省略

for (int i = 0; i < 100; i++) DoSomething(i);

// 例: 中括弧を明確にしておく

for (int i = 0; i < 10; i++)
{
	for (int j = 0; j < 10; j++)
     {
		ExampleAction();
     }
}
// 避ける: 入れ子になった複数行のステートメントから中括弧を削除する

for (int i = 0; i < 10; i++)
	for (int j = 0; j < 10; j++)
		ExampleAction();

// 例: switchステートメントからcaseをインデントする
switch (someExpression) 
{
   case 0:
      DoSomething();
      break;
   case 1:
      DoSomethingElse();
      break;
   case 2: 
      int n = 1;
      DoAnotherThing(n);
      break;
}

// 例: 引数間のカンマの後に半角スペースを入れる
CollectItem(myObject, 0, 1);

// 避ける:
CollectItem(myObject,0,1);

// 例: メソッド名と括弧の間のスペースは省略する
DoSomething()

// AVOID:
DoSomething ()

// 例: 括弧内のスペースは省略する
x = dataArray[index];

// AVOID:
x = dataArray[ index ];

// 例: 括弧はスペースで区切る
while (x == y)

// 避ける:
while(x==y)

// 例: 括弧はスペースで区切る
if (x == y)
// 避ける:
if (x==y)

// 例: 種類と名前の間に1スペース

    public float Speed = 12f;
    public float Gravity = -10f;
    public float JumpHeight = 2f;

    public Transform GroundCheck;
    public float GroundDistance = 0.4f;
    public LayerMask GroundMask;

// 避ける: 列を揃える

    public float                Speed = 12f;
    public float                Gravity = -10f;
    public float                JumpHeight = 2f;
    public Transform            GroundCheck;
    public float                GroundDistance = 0.4f;
    public LayerMask            GroundMask;

// スタイルシートの例
// - これは、あなたのUnityプロジェクトで使用するためのスタイルガイドの例です。
// - チームの好みに合わせて、これらのルールを省略したり追加したりしてください。
// - スタイルガイドの例を参考にしてください：
// - Microsoftのフレームワークデザインガイドラインはこちら: https://docs.microsoft.com/en-us/dotnet/standard/design-guidelines/
// - Googleもスタイルガイドをここで管理しています: https://google.github.io/styleguide/csharp-style.html

// - これらのルールをカスタマイズして、チーム独自のスタイルガイドを作成し、一貫して適用する。
// - 疑問がある場合は、チームのスタイルガイドを優先すること。

// 命名/ケーシング：
// - 特に断りのない限り、パスカルケース（例：ExamplePlayerController、MaxHealthなど）を使用する。
// - ローカル/プライベート変数、パラメータにはキャメルケース（examplePlayerController、maxHealthなど）を使用する。
//  -スネークケース、ケバブケース、ハンガリー記法は避ける。
// - ファイル内にMonobehaviourがある場合、ソースファイル名を一致させること


// フォーマット：
// - K&R（同じ行で中括弧を開く）またはオールマン（改行で中括弧を開く）スタイルの中括弧を選択する。
// - 行を短くする。水平方向の空白を考慮する。スタイルガイドで標準的な行の幅を定義する（80～120文字）。
// - フロー制御条件の前に半角スペースを入れる 例：while (x == y)。
// - 括弧の中にはスペースを入れない。例；x = dataArray[index]
// - 関数の引数間のカンマの後には半角スペースを使用する。
// - 括弧と関数引数の後にスペースを追加しないでください。例えば、CollectItem(myObject, 0, 1)；
// - 関数名と括弧の間にスペースを使用しない。例：DropPowerUp(myPrefab, 0, 1)；
// - 視覚的に区切るために、縦の間隔（余分な空白行）を使用する。

// コメント
// - 単に "何を"、"どのように "と答えるのではなく、コメントによってギャップを埋め、"なぜ "なのかを伝えることができる。
// - コメントを使用して、ロジックの隣に説明を置いてください。
// - シリアライズされたフィールドには、コメントの代わりにツールチップを使用してください。
// - リージョンは避けてください。大きなクラスサイズを助長します。折りたたまれたコードは読みにくくなります。
// - 法的な情報やライセンスについては、外部リファレンスへのリンクを使用してスペースを節約してください。
// - パブリック・メソッドや関数の前にサマリーXMLタグを記述して、ドキュメントやインテリセンスを出力する。


// 行を使用する：
// - ファイルの先頭にusing行を残す。
// - 未使用行を削除する。
using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using System;

// NAMESPACES：
// - 特殊記号やアンダースコアは使わない。
// - 名前空間を繰り返し入力しないように、先頭に使用行を追加する。
// - 例えば、MyApplication.GameFlow、MyApplication.AIなど。
namespace StyleSheetExample
{

    // 列挙型：
    // - 単数形の型名を使用する。
    // - 接頭辞や接尾辞は付けない。
    public enum Direction
    {
        North,
        South,
        East,
        West,
    }

    // フラグ列挙：
    // - 複数形の型名を使う 
    // - 接頭辞や接尾辞は付けない。
    // - バイナリ値にはカラムアライメントを使用する。
    [Flags]
    public enum AttackModes
    {
        // Decimal                         // Binary
        None = 0,                          // 000000
        Melee = 1,                         // 000001
        Ranged = 2,                        // 000010
        Special = 4,                       // 000100

        MeleeAndSpecial = Melee | Special  // 000101
    }

    // インターフェイス：
    // - インターフェースには形容詞句を付ける。
    // - I' 接頭辞を使用する。
    public interface IDamageable
    {
        string damageTypeName { get; }
        float damageValue { get; }

        // メソッド：
        // メソッド名は、動作を示す動詞または動詞句で始めます。
        // パラメータ名はキャメルケースで指定します。
        bool ApplyDamage(string description, float damage, int numberOfHits);
    }

    public interface IDamageable<T>
    {
        void Damage(T damageTaken);
    }

    // クラスまたは構造体：
    // - 名詞または名詞句で名前を付ける。
    // - 接頭辞は避ける。
    // - 1つのファイルに1つのMonobehaviour。ファイル内にMonobehaviourがある場合、ソースファイル名が一致していなければなりません。
    public class StyleExample : MonoBehaviour
    {

        // フィールド： 
        // - 特殊文字（バックスラッシュ、記号、Unicode文字）は避けること。 コマンドラインツールと干渉する可能性がある。
        // - 名前には名詞を使いますが、ブーリアンには動詞を前置します。
        // - 意味のある名前を使う。検索しやすく、発音しやすい名前にする。数学でない限り）省略しない。
        // - パブリック・フィールドにはパスカル・ケースを使用する。プライベート変数にはキャメルケースを使用する。
        // - ローカル変数と区別するために、プライベートフィールドの前にアンダースコア (_) を追加します。
        // - より明示的な接頭辞を使用することもできます。 m_ = メンバ変数, s_ = スタティック, k_ = コンスタント 
        // - デフォルトのアクセス修飾子を指定する（あるいは省略する）。

        private int _elapsedTimeInDays;

        // インスペクタにプライベート・フィールドを表示するには、[SerializeField] 属性を使用します。
        // ブーリアンは、true または false で答えられる質問をします。
        [SerializeField] private bool _isPlayerDead;

        // これは、カスタムPlayerStatsクラスのデータをInspectorにグループ化します。
        [SerializeField] private PlayerStats _stats;

        // これにより、値が範囲に制限され、インスペクタにスライダが作成されます。
        [Range(0f, 1f)][SerializeField] private float _rangedStat;

        // ツールチップは、直列化されたフィールドのコメントを置き換えることができ、二重の役割を果たす
        [Tooltip("This is another statistic for the player.")]
        [SerializeField] private float _anotherStat;


        // プロパティ：
        // - public フィールドが望ましい。
        // - 特殊文字は使用しない。
        // - 短くするために式本体化プロパティを使用するが、好みの形式を選択する。
        // - 例えば、読み取り専用のプロパティには式修飾を使用し、それ以外には { get; set; } を使用します。
        // - バッキング・フィールドのないパブリック・プロパティには、自動実装プロパティを使用してください。

        // プライベートバッキングフィールド
        private int _maxHealth;

        // 読み取り専用、バッキングフィールドを返す
        public int MaxHealthReadOnly => _maxHealth;

        // 次と同等です
        // public int MaxHealth { get; private set; }

        // ゲッターとセッターの明示的な実装
        public int MaxHealth
        {
            get => _maxHealth;
            set => _maxHealth = value;
        }

        // 書き込み専用（バッキングフィールドを使用しない）
        public int Health { private get; set; }

        // 書き込み専用、明示的なセッターなし
        public void SetMaxHealth(int newMaxValue) => _maxHealth = newMaxValue;

        // バッキング・フィールドのない自動実装プロパティ
        public string DescriptionName { get; set; } = "Fireball";


        // EVENTS：
        // - 動詞句で名前を表す。
        // - 現在の行動は "before "を意味し、過去の行動は "after"を意味する。
        // - ほとんどのイベントにはSystem.Actionデリゲートを使用する（0～16個のパラメータを取ることができる）。
        // - 必要な場合のみ、カスタムEventArgを定義する（System.EventArgsまたはカスタム構造体）。
        // - あるいは、System.EventHandlerを使用します。
        // - イベント、イベント処理メソッド（サブスクライバ/オブザーバ）、イベント発生メソッド（パブリッシャ/サ ブジェクト）の命名スキームを選択します。
        // 例えば、イベント/アクション = "OpeningDoor"、イベント発生メソッド = "OnDoorOpened"、イベント処理メソッド = "MySubject_DoorOpened" など。

        // event before
        public event Action OpeningDoor;

        // event after
        public event Action DoorOpened;

        public event Action<int> PointsScored;
        public event Action<CustomEventArgs> ThingHappened;

        // これらは、OnDoorOpenedやOnPointsScoredなどのイベント発生メソッドである。
        public void OnDoorOpened()
        {
            DoorOpened?.Invoke();
        }

        public void OnPointsScored(int points)
        {
            PointsScored?.Invoke(points);
        }

        // これは構造体から作られたカスタムEventArgです。
        public struct CustomEventArgs
        {
            public int ObjectID { get; }
            public Color Color { get; }

            public CustomEventArgs(int objectId, Color color)
            {
                this.ObjectID = objectId;
                this.Color = color;
            }
        }


        // メソッド：
        // - メソッド名は、動作を示す動詞または動詞句で始める。
        // - パラメータ名はキャメルケースで指定します。

        // メソッドは動詞で始まります。
        public void SetInitialPosition(float x, float y, float z)
        {
            transform.position = new Vector3(x, y, z);
        }

        // メソッドはブールを返すとき、疑問形にする
        public bool IsNewPosition(Vector3 newPosition)
        {
            return (transform.position == newPosition);
        }

        private void FormatExamples(int someExpression)
        {
            // VAR：
            // - 特に長い型名では、可読性を高めるために var を使う。
            // - 型が曖昧になる場合は var を使わない。
            var powerUps = new List<PlayerStats>();
            var dict = new Dictionary<string, List<GameObject>>();


            // switch文：
            // - 書式はさまざまです。あなたのスタイル・ガイドに合ったものを選び、それに従いましょう。
            // - この例では、各ケースとその下のブレークをインデントしています。
            switch (someExpression)
            {
                case 0:
                    // ..
                    break;
                case 1:
                    // ..
                    break;
                case 2:
                    // ..
                    break;
            }

            // 中括弧： 
            // - 単一行ステートメントを使用する場合は、わかりやすくするために中括弧を使用する。
            // - あるいは、デバッグしやすくするために単一行文を完全に避ける。
            // - 入れ子になった複数行のステートメントでは中括弧を保持する。

            // この1行のステートメントでは、中括弧を...
            for (int i = 0; i < 100; i++) { DoSomething(i); }

            // ...しかし、この方がデバッグしやすい。節にブレークポイントを設定できる。
            for (int i = 0; i < 100; i++)
            {
                DoSomething(i);
            }

            // ここで中括弧を外してはいけない。
            for (int i = 0; i < 10; i++)
            {
                for (int j = 0; j < 10; j++)
                {
                    DoSomething(j);
                }
            }
        }

        private void DoSomething(int x)
        {
            // .. 
        }
    }
    // その他のクラス
    // - 必要なだけ、他のヘルパー／Monobehaviourではないクラスを定義します。
    // - これは、Inspector のフィールドをグループ化するシリアライズ可能なクラスです。
    [Serializable]
    public struct PlayerStats
    {
        public int MovementSpeed;
        public int HitPoints;
        public bool HasHealthPotion;
    }

}