10.7K Views
November 17, 23
スライド概要
UE Tokyo .dev #2で発表した資料です。
UEの命名規則についてご紹介 pate(ぱて) UE歴3年 1
名前を付けるとき、何か意識してますか? 2
UEには命名する場面がたくさん! 3
一例をご紹介します 1. ※1234 基本的な考え方 a. b. c. PascalCaseを使う 「短いけど分かりにくい名前」より「長いけど分かりやすい名前」を優先す る 名前の順番はマクロ → ミクロにする 2. アセット名 3. 変数名 ※1 あくまで私の考え方です ※2 参考程度に聞いてください ※3 命名規則は宗教と似ているので簡単に信じないでください ※4 命名規則を軽んじることはギルティー 4
共同開発ではもちろん、 個人開発者に特に意識してほしい! 5
1.a. PascalCaseを使う UEはこれ→ 言語の標準ライブラリに合わせる BPでノードをダブルクリックすると VSが起動するので見てみると楽しいです 6
1.b. 「短いけど分かりにくい名前」より「長いけど分かりやすい名前」を優先する 7
1.b. 「短いけど分かりにくい名前」より「長いけど分かりやすい名前」を優先する 省略文字はギルティー あれこれ考えずに英文法で書いてしまおう! 8
1.c. 名前の順番はマクロ → ミクロにする アルファベット順に並ぶことを意識 して、関連するファイルを分かりやすくする https://youtu.be/V40sMUAE5ek?si=39WGeNh_uK-rKLhV 9
2. アセット名 Asset Type Prefix(接頭辞)をつけると何のアセットなのかが分かりやすい 全部Mannyだったらカオスが極まるので、 アセット名の頭にアセットを識別する ATPを つける。 公式でも推奨されている。 やらねばギルティー。 例:M_Manny、T_Manny_BC https://www.unrealdirective.com/resource/asset-naming-conventions https://docs.unrealengine.com/5.3/ja/recommended-asset-naming-conventions-in-unreal-engine-projects/ 10
3. 変数名(特にBoolean) trueでどうなる? 何が認証されたかのフラグ? そもそもFlagをBool型に用いることがギルティー 命題となるように命名する 良い例:IsEmpty、HasChildren、UserExists IsNotFinishedのように読み手が混乱を招く否定形は避ける 11
1ヶ月後に見返しても、 1分前に作ったかのように思い出せる名前を付けよう! 12