File name conventions in other page: here
General Rules:
- Always have proper indentation / order
- Every name must be self descriptive.
- Use proper english as much as possible. Grammar mistakes disrupt workflow and waste time on debugging.
Common (BP & C++)
Names:
- Classes:
CapitalNotation- Including both the class name and the file names.
- without 'BP' suffix like "CombatKnife_BP"
- Functions:
camelCaseNotation(different for UE-C++, on that later in this card) - Variables:
underscore_notation_non_capital
Every name must be self descriptive.
BP:
- Events & Macros - same as functions (camelCase)
C++:
- Macros:
ALL_CAPS_WITH_UNDERSCORES - Use 1TBS ( https://en.wikipedia.org/wiki/Indentation_style )
C++ UE:
C++ classes with standard UE naming, example: AEquipable
unless the class has BP wrapper around it: in such case the C++ class will have _CPP right after it, while the BP will be under trivial name, example: "Shoe" (BP class) inherits > "AShoe_CPP" Otherwise "Shoe_BP" inherits "AShoe" (C++)
Function Namings:
asCamelCaseAsPossible_Implementation()- UE's C++ preprocessor has some rules which must be respected, but keep the names as camel case as possible.
- Use _onServer / _multicast ... endings for network functions.
- Examples:
- fire_onServer_Implementation()
- fire_multicast_Implementation()
Comment Tags:
- //- to be removed
- //+ to add
- //# to fix
- //! critical
- //% can be optimized
notes:
- you can ctrl+f each of them to find what you need to edit, fix, or clean
- you can combine them one after another like this "//+ //!" for ease of search. not "//+!"