【Unity】個人ゲーム開発準備まとめ｜バージョン管理(Git)／コーディング規約など

開発準備

今回はゲーム開発を始める前に開発環境やバージョン管理について、自分なりにまとめておきます。

開発環境

以下の環境で開発を行なっていきます。　※2021/3/21時点

MacOS Catalina 10.15.7
Unity 2019.4.20f1
Unity Hub 2.4.3
Visual Studio 2019 (community)

バージョン管理

バージョン管理はGit、管理ツールはSourcetreeを使用し、ローカルリポジトリで管理します。

バージョン管理：Git (GUI: Sourcetree)

命名規則

コーディング時の命名規則はUnityに合わせて以下のようにします。

パスカルケース：クラス、メソッド、列挙型、etc…
キャメルケース：変数、定数、引数

ネーミングに迷ったときはcodicを参考にします。あとは個人的な好みとして、命名時に英単語の省略はしないようにします（省略が一般化している単語は除く）。

ドキュメントコメント

C#プログラミングガイドを参考にsummary, param, returns （///入力して自動挿入してくれるコメント）を使用します。

/// <summary>
/// メソッドの説明を記載します。
/// </summary>
/// <param name="arg">引数の説明を記載します。</param>
/// <returns>戻り値の説明を記載します。</returns>
int SampleMethod(int arg)
{
    int value = 1;
    return value;
}