メソッドや変数の命名規則 - i-school

　メソッドや変数の命名規則は、コードの可読性を高めるために非常に重要です。
適切な命名規則を守ることで、他の開発者があなたのコードを理解しやすくなります。

　ここではメソッドや変数の命名規則について解説します。

参考サイト

MicroSoft
C# 識別子の名前付け規則と表記規則

Qiita @Z0E 様
Visual Studio で C# の命名規則をチェックする

変数の命名規則

　変数の命名規則は、変数の種類やスコープによって異なります。

　基本的には、変数名は英語の小文字で始め、単語の区切りごとに大文字を使うキャメルケース（camelCase）を使用します。

　また、変数名は具体的でわかりやすく、その役割を示すべきです。

ローカル変数

　ローカル変数は、メソッド内でのみ使用される変数です。
ローカル変数の命名はキャメルケースを使用し、変数名は具体的でわかりやすくすべきです。

クリックすると開きます

void CalculateScore()
{
    int totalScore = 0;
    int bonusScore = 100;
    totalScore += bonusScore;
}

メンバ変数（フィールド）

　メンバ変数は、クラス内で使用される変数で、アンダースコア（_）で始めることが一般的です。
これにより、メンバ変数とローカル変数を区別しやすくなります。

クリックすると開きます

public class Player
{
    private int _health = 100;
    private int _experience = 0;
    
    public void TakeDamage(int damage)
    {
        _health -= damage;
    }
}

メソッドの命名規則

　自作したメソッド名は、英語の大文字で始め、単語の区切りごとに大文字を使うパスカルケース（PascalCase）を使用します。
また、メソッド名は動詞で始めることが一般的で、そのメソッドが何をするのかを明確に示すべきです。

　また自作したメソッドにはサマリーをつけるようにし、メソッドを要約してまとめておきます。

通常のメソッド

クリックすると開きます

/// <summary>
/// メソッドの内容を要約し、簡潔に書いておく
/// </summary>
public class Player
{
    private int _health = 100;
    
    public void TakeDamage(int damage)
    {
        _health -= damage;
    }
    
    public void Heal(int healing)
    {
        _health += healing;
    }
}

コルーチンの命名規則

　コルーチンは、Unityで独自の非同期処理を行うための機能です。
コルーチンは、IEnumeratorを戻り値とするメソッドで実装されます。

　コルーチンの命名規則は、基本的なメソッドの命名規則に従いつつ、メソッド名の末尾に “Coroutine” または “Co” を追加することが一般的です。
これにより、コルーチンであることを明示的に示すことができます。

クリックすると開きます

/// <summary>
/// メソッドの内容を要約し、簡潔に書いておく
/// </summary>
public IEnumerator MoveObjectCoroutine(Vector3 targetPosition, float duration)
{
    // コルーチンで実行するコード
}

/// <summary>
/// メソッドの内容を要約し、簡潔に書いておく
/// </summary>
public IEnumerator FadeOutCo(float duration)
{
    // コルーチンで実行するコード
}

async メソッドの命名規則

　async メソッドは、コルーチンと同じく非同期処理を行うメソッドです。
C# に用意されている Task を利用するか、あるいは、UniTask アセットを利用することで実装できます。

　async メソッドの命名規則は、基本的なメソッドの命名規則に従いつつ、メソッド名の末尾に “Async” を追加することが一般的です。
これにより、非同期処理を行うメソッドであることを明示的に示すことができます。

クリックすると開きます

/// <summary>
/// メソッドの内容を要約し、簡潔に書いておく
/// </summary>
public async UniTask LoadDataAsync()
{
    // 非同期処理を行うコード
}

/// <summary>
/// メソッドの内容を要約し、簡潔に書いておく
/// </summary>
public async UniTask<string> FetchDataAsync(string url)
{
    // 非同期処理を行うコード
}

まとめ

　これらの命名規則に従うことで、コードの可読性を向上させ、他の開発者があなたのコードを理解しやすくなります。
また、命名規則を統一することで、開発チーム内でのコミュニケーションも円滑になります。

　自分の書いたソースコードを見直し、適切な命名規則になっているか、確認してみましょう。
またリファクタリングを行い変更を行ってもよいでしょう。

　その場合には、Visual Studio であれば「名前の変更」から変更するようにしてください。
参照先もまとめて一括修正されます。