UE5/UE4 C++におけるクラス(Class)、構造体(Struct)、列挙型(Enum)、変数、引数の命名規則(AActor、UObject、SWidget、FStruct、EEnum、bBool、IInterface)
ドキュメントを見れば書いてあるのですが忘れやすいのでメモということで…。
公式ドキュメントはこちらになります。
・コーディング規約
https://docs.unrealengine.com/4.27/ja/ProductionPipelines/DevelopmentSetup/CodingStandard/
クラス(Class)はこう記載されています。
継承元によって接頭辞が変わる。といったもののようですね。テンプレートクラスには接頭辞 T が付きます。
UObject から継承されるクラスには接頭辞 U が付きます。
AActor から継承されるクラスには接頭辞 A が付きます。
SWidget から継承されるクラスには接頭辞 S が付きます。
C抽象インターフェースのクラスには接頭辞 I が付きます。
列挙型変数には接頭辞 E が付きます。
その他のほとんどのクラスには接頭辞 F が付きますが、サブシステムによっては別の文字が使用されます。
構造体(Struct)はこう記載されています。
Typedef には、その型に対して適切な接頭辞が付きます。
構造体の typedef の場合は、F に、
UObject の typedef の場合は、U になる等のようになります。
列挙型(Enum)はこう記載されています。
列挙型変数には接頭辞 E が付きます。
変数はこう記載されています。
ブール変数には、必ず接頭辞 b を付けてください (例、bPendingDestruction や bHasFadedIn)。
引数はこう記載されています。
必須ではありませんが、参照から渡されたり、関数によって値が書かれる場合は、
関数パラメータ名に「Out」を接頭辞として付けることを推奨します。
こうすることで、引数に渡された値が関数によって置き換えられることが明白になります。
In または Out のパラメータも boolean の場合、In/Out の接頭辞の前に b を付けます (例: bOutResult)。
UE5/UE4 独自のルールだと思いますが、慣れてくれば考えなくてもいけそうな気がしますね。
| UE4 | 10:00 | comments:0 | trackbacks:0 | TOP↑