UE4编码规范
发表于2016-02-26
翻译原文为Unreal 的官方！自己看着总结了一下，不一定每条都能对上。不足之处，请多多指教！
一、UE4编码规范
1、在Epic，有简单几条代码编写标准：
（1）、代码生命的80%时间在于维修
（2）、没有一个软件在整个过程中只有原作者在维护
（3）、编码规范可以提供软件可读性，新手可迅速透彻理解代码。新的工程师来会建立新的工程修改代码。
（4）、若对社区开发者放出源码，希望代码易于理解。
（5）、需要满足交叉编译。
2、命名规范
（1）、首字母大写，不使用下划线
（2）、第一个字母为变量类型。
模块前缀为T
继承UObject前缀为U
继承AActor前缀为A
继承SWidget前缀为S
继承抽象接口前缀为I
其他大多数前缀为F，也有一些子类用其他字母。
（3）、类型和变量为名词
（4）、方法行为名称为动词，描述方法作用，或返回值。
变量和方法，类名需要清晰，避免过度缩写。
所有变量一次只能声明一个，注释可以正常使用。javaDocs类型需要它们。你可以多行或单行注释来注释。
函数需要返回bool型，bool变量的前缀为b.
无返回值函数，需要动词后面加对象。名称避免不明确功能的字眼
3、基础C++对象类型
bool不要使用BOOL
TCHAR,不用使用CHAR
uint8
int8
uint16
int16
uint32
int32
Uint64
Int64
Float,单精度浮点
Double,双精度浮点数
PTRINT，带有指针的整型
4、注释
注释即沟通，沟通很关键。将注释印在脑海。（Kernighan & Pike The Practice of Programming ）
UE4使用JavaDoc来自动解析代码注释，编译生成文档。所以要注意注释格式。
5、C++11新特性使用
可以很好支持的目前主要有auto,for循环和lambda表达。有时候我们只是用宏定义这样特性折叠了。
（1）、Auto
使用auto,在编译期间绑定变量类型。若鼠标悬停在vs变量上，将会告诉你auto变量的实际类型。
（2）、For循环
代码更简洁，易于维护。
（3）、Lambda表达匿名函数
Lambda是可用的，但是目前我们使用很谨慎。
二、第三方代码
1、编码格式
{}需要另起一行。
If-else，任何使用都要使用括号。多行可用把else-if放在一行上。
Switch，必有一个default.
2、命名空间
（1）、使用自己的命名空间，注意不要重名，尤其不要与第三方库重名
（2）、不使用using在全局范围，甚至在cpp中也不使用。
（3）、在命名空间里使用命名空间，或在函数内使用命名空间是没问题。
（4）、使用命名空间要确认一致性。
（5）、前向声明类型需要在他们单独的命名空间中进行。
（6）、若声明了大量的类或类型在一个命名空间下，则在全局范围内使用需要明确的支出命名空间
（7）、Using，最好不要使用别名。
（8）、枚举类型在命名空间里声明，防止全局都可见。
3、物理独立
所有编译器支持#pragma once.
要直接使用头文件包含，不要间接的使用。
不要担心头文件的的预编译头设置，UnrealBuild比你做的要好。
4、常见格式
（1）、变量在最近的使用地方定义。
（2）、尽可能分割多的方法。
（3）、函数声明或调用，函数名称之前不要空格。
（4）、在.h和cpp文件结尾加上一行空格，因为Gcc编译需要。
（5）、不要把浮点float隐形转换为int，因为不是所以编译器可以编译的。要使用appTrunc()来转换。
（6）、不是接口的，要用private类型保护数据。
（7）、接口类不要写变量。接口类里允许非纯虚函数，或非虚函数或静态函数的。
（8）、多使用const.
（9）、分割多个表达，使代码易于理解。使用中间变量使复杂表达简单化。
const bool bIsLegalWindow = Blah->BlahP->WindowExists->Etc && Stuff;
const bool bIsPlayerDead = bPlayerExists && bGameStarted && bPlayerStillHasPawn && IsTuesday();
if (bIsLegalWindow && !bIsPlayerDead)
{
DoSomething();
}
（10）、虚函数记得使用override
（11）、指针的*号，靠近对象来放置，便于搜素某类型的指针类对象。
加入GAD的核心用户QQ群：484290331，各类活动奖励任你拿，最新资讯任你读，众多教学任你免费学，如此好地方赶紧加入吧！另VR专属群：476511561，专业VR技术分享，专业导师指导为你答疑解惑，大型小型活动奖励等你拿，免费学习赚奖励的天地，欢迎你加入哟！