枚举命名规范_UE4 C++基础教程 - 编码规范

为什么要学习编码规范？

良好的编码规范不仅利于项目维护，也增加了代码辨识度。使我们在阅读代码时能够更加清晰的理解代码意图。维护编码规范不是一件机械化的工作，它更像是一门艺术，让我们在有限的规范内发挥自己的创造力。除此之外，还有如下几个原因：

• 软件生命周期中80%的时间皆需要维护。
• 原开发者几乎不会对软件进行终身维护。
• 代码规则可提高软件可读性，让工程师更加快速透彻地理解新代码。
• 如决定向模组社区开发者公开源代码，则源代码需要易于理解。
• 交叉编译器兼容性实际上需要此类规则。

详细的编码规范可以参考UE4的官方文档^[1]，这里我们只摘录其中有利于初学者阅读代码的部分。

UE4命名规范

Pascal命名法

每个单词首字母大写，如 Health或 UPrimitiveComponent 。变量、方法和类的命名应清楚、明了且进行描述。命名的范围越大，一个良好的描述性命名就越重要。避免过度缩写。所有变量应逐个声明，以便对变量的含义提供注释。其同样被JavaDocs格式需要。变量前可使用多行或单行注释，空白行为分组变量可选使用。

类型前缀

类型名称前有一个额外的大写字母用于区分不同的类型和普通的变量名。如 FSkin 是个类型名，Skin 则是