Unity公式サイトのCreate a C# style guide: Write cleaner code that scalesで紹介されていたコードスタイルサンプルをざっくり和訳して、ちょっと自分用にカスタマイズしたコードスタイル例です。
オリジナルはこちら
チーム開発をする際に先立ってコードスタイルガイドを用意することで、開発メンバー者がどのようなルールに従ってコードを書くべきかを明確にすることができます。
コードの書き方に正解はありませんが、チーム全体でコードスタイルを統一することは読みやすく拡張性が高いコードの開発に役立ちます。
手軽さとUnityのクラスにあわせるために以下の修正をしました。
- デフォルト修飾子( private や this )は省略
- インターフェースのプロパティをパスカルケースに変更
- 変数は一律キャメルケース。privateの_は省略
以下を追加しました。
- public 変数のプロパティ化の推奨
既存のガイドラインを参考にして、自分たちのガイドラインを作成するのは良いやり方です。
Unity開発の際の一般的なコーディング規約については、Unity公式サイトにて紹介されています。このガイドラインはMicrosoft Framework Design guidelinesを元に作成しています。
このガイドラインは参考にはなりますが絶対的なものではありません。疑問がある部分は、チームで話し合って合意できるルールに改めてください。個々のルールの詳細よりも、チーム全体でルールを統一することが重要です。